BenchPrep GraphQL API API Reference
Welcome to BenchPrep GraphQL API documentation.
Its schema can be fetched using introspection query and can be used for generating code, documentations, tests etc.
GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. GraphQL provides a complete and understandable description of the data in your API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.
Please start looking by checking out our GraphQL Guides and supported operations
API Endpoints
Development Server:
http://benchprep.localhost/api/graphql
Integration Server:
https://integration.benchprep.com/api/graphql
Staging Server:
https://staging.benchprep.com/api/graphql
Production Server:
https://benchprep.com/api/graphql
Terms of Service: https://benchprep.com/terms
Contact: support@benchprep.com
Version: 0.1.0
Queries
BenchPrep's exposed queries
Request branchPlans
Returns list of BranchPlans
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query branchPlans($filters: BranchPlanFilter, $sort: BranchPlanSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
branchPlans(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"query": "string",
"branchId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query branchPlans($filters: BranchPlanFilter, $sort: BranchPlanSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
branchPlans(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"query": "string",
"branchId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branchPlans": {
"totalCount": "integer"
}
}
}
Request branches
Returns specific Branches
.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query branches($filters: BranchFilter, $sort: BranchSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
branches(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"parentBranchId": "string",
"rootOnly": "boolean",
"excludedBranchId": "string",
"treeByBranchId": "string",
"treeByBranchIdExcludingSelf": "string",
"canHaveChildren": "boolean",
"query": "string",
"ancestorsByBranchId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query branches($filters: BranchFilter, $sort: BranchSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
branches(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"parentBranchId": "string",
"rootOnly": "boolean",
"excludedBranchId": "string",
"treeByBranchId": "string",
"treeByBranchIdExcludingSelf": "string",
"canHaveChildren": "boolean",
"query": "string",
"ancestorsByBranchId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branches": {
"totalCount": "integer"
}
}
}
Request branding
Returns specific Branding
.
Example
Request Content-Types:
application/json
Query
query branding{
branding{
brandableId
brandableType
colorLogoUrl
emailLogoUrl
faviconUrl
id
mobileIconUrl
primaryColor
secondaryColor
whiteLogoUrl
}
}
Try it now
query branding{
branding{
brandableId
brandableType
colorLogoUrl
emailLogoUrl
faviconUrl
id
mobileIconUrl
primaryColor
secondaryColor
whiteLogoUrl
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branding": {
"brandableId": "string",
"brandableType": "string",
"colorLogoUrl": "string",
"emailLogoUrl": "string",
"faviconUrl": "string",
"id": "string",
"mobileIconUrl": "string",
"primaryColor": "string",
"secondaryColor": "string",
"whiteLogoUrl": "string"
}
}
}
Request certificates
Returns list of Certificate
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query certificates($filters: CertificateFilter, $sort: CertificateSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
certificates(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query certificates($filters: CertificateFilter, $sort: CertificateSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
certificates(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"certificates": {
"totalCount": "integer"
}
}
}
Request contentPackages
Returns list of ContentPackage
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query contentPackages($filters: ContentPackageFilter, $sort: ContentPackageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
contentPackages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"query": "string",
"state": "string",
"excludedIds": [
"string"
],
"hasStudyPlan": "boolean",
"hasCertificates": "boolean",
"hasExams": "boolean",
"bank": "boolean",
"hasExternalPackages": "boolean",
"enrolledFor": "number",
"courseType": "string",
"hasMilestones": "boolean",
"isRecognitionIssuing": "boolean",
"hasRecognitions": "boolean",
"branchPlanIdPlusContentPackageIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"notBranchPlanIdPlusContentPackageIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"planIdPlusContentPackageIds": {
"planId": "string",
"ids": [
"string"
]
},
"notPlanIdPlusContentPackageIds": {
"planId": "string",
"ids": [
"string"
]
},
"ltiDeploymentIdPlusContentPackageIds": {
"ltiDeploymentId": "string",
"ids": [
"string"
]
},
"notLtiDeploymentIdPlusContentPackageIds": {
"ltiDeploymentId": "string",
"ids": [
"string"
]
}
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query contentPackages($filters: ContentPackageFilter, $sort: ContentPackageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
contentPackages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"query": "string",
"state": "string",
"excludedIds": [
"string"
],
"hasStudyPlan": "boolean",
"hasCertificates": "boolean",
"hasExams": "boolean",
"bank": "boolean",
"hasExternalPackages": "boolean",
"enrolledFor": "number",
"courseType": "string",
"hasMilestones": "boolean",
"isRecognitionIssuing": "boolean",
"hasRecognitions": "boolean",
"branchPlanIdPlusContentPackageIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"notBranchPlanIdPlusContentPackageIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"planIdPlusContentPackageIds": {
"planId": "string",
"ids": [
"string"
]
},
"notPlanIdPlusContentPackageIds": {
"planId": "string",
"ids": [
"string"
]
},
"ltiDeploymentIdPlusContentPackageIds": {
"ltiDeploymentId": "string",
"ids": [
"string"
]
},
"notLtiDeploymentIdPlusContentPackageIds": {
"ltiDeploymentId": "string",
"ids": [
"string"
]
}
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"contentPackages": {
"totalCount": "integer"
}
}
}
Request contentTypes
Returns list of ContentType
s.
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query contentTypes($offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
contentTypes(offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query contentTypes($offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
contentTypes(offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"contentTypes": {
"totalCount": "integer"
}
}
}
Request currentTenant
Returns information about the CurrentTenant
(resolver).
Example
Request Content-Types:
application/json
Query
query currentTenant{
currentTenant{
bigCommerceSsoEnabled
ecommerceEnabled
id
name
publicUrl
slug
}
}
Try it now
query currentTenant{
currentTenant{
bigCommerceSsoEnabled
ecommerceEnabled
id
name
publicUrl
slug
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"currentTenant": {
"bigCommerceSsoEnabled": "boolean",
"ecommerceEnabled": "boolean",
"id": "string",
"name": "string",
"publicUrl": "string",
"slug": "string"
}
}
}
Request currentUser
Returns information about the currently authenticated CurrentUser
(resolver).
Example
Request Content-Types:
application/json
Query
query currentUser{
currentUser{
createdAt
email
id
name
permissionSlugs
roleSlugs
state
}
}
Try it now
query currentUser{
currentUser{
createdAt
email
id
name
permissionSlugs
roleSlugs
state
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"currentUser": {
"email": "string",
"id": "string",
"name": "string",
"permissionSlugs": [
"string"
],
"roleSlugs": [
"string"
],
"state": "string"
}
}
}
Request currentUserRole
Returns information about the currently authenticated UserRole
.
Example
Request Content-Types:
application/json
Query
query currentUserRole{
currentUserRole{
accessContext
accessContextId
accessContextType
applicableAccessContexts
id
permissionSlugs(filter: $filter)
properties
roleSlug
userId
}
}
Try it now
query currentUserRole{
currentUserRole{
accessContext
accessContextId
accessContextType
applicableAccessContexts
id
permissionSlugs(filter: $filter)
properties
roleSlug
userId
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"currentUserRole": {
"accessContextId": "string",
"accessContextType": "string",
"applicableAccessContexts": [
null
],
"id": "string",
"permissionSlugs": [
"string"
],
"roleSlug": "string",
"userId": "string"
}
}
}
Request developerTokens
Returns list of DeveloperTokens
s.
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query developerTokens($sort: DeveloperTokenSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
developerTokens(sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query developerTokens($sort: DeveloperTokenSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
developerTokens(sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"developerTokens": {
"totalCount": "integer"
}
}
}
Request domains
Returns registered Domains
(resolver) to the current tenant.
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query domains($filters: DomainFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
domains(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query domains($filters: DomainFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
domains(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"domains": {
"totalCount": "integer"
}
}
}
Request emailTemplates
Returns list of EmailTemplates
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query emailTemplates($filters: EmailTemplateFilter, $sort: EmailTemplateSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
emailTemplates(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query emailTemplates($filters: EmailTemplateFilter, $sort: EmailTemplateSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
emailTemplates(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"emailTemplates": {
"totalCount": "integer"
}
}
}
Request enrollments
Returns list of Enrollment
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query enrollments($filters: EnrollmentFilter, $sort: EnrollmentSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
enrollments(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query enrollments($filters: EnrollmentFilter, $sort: EnrollmentSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
enrollments(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"enrollments": {
"totalCount": "integer"
}
}
}
Request examResults
Returns list of ExamResult
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query examResults($filters: ExamResultFilter, $sort: ExamResultSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
examResults(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"userId": [
"string"
],
"examId": "string",
"examName": "string",
"contentPackageId": "string",
"query": "string",
"withDeleted": "boolean"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query examResults($filters: ExamResultFilter, $sort: ExamResultSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
examResults(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"userId": [
"string"
],
"examId": "string",
"examName": "string",
"contentPackageId": "string",
"query": "string",
"withDeleted": "boolean"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"examResults": {
"totalCount": "integer"
}
}
}
Request exams
Returns list of Exam
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query exams($filters: ExamFilter, $sort: ExamSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
exams(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query exams($filters: ExamFilter, $sort: ExamSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
exams(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"exams": {
"totalCount": "integer"
}
}
}
Request externalPackages
Returns list of ExternalPackage
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query externalPackages($filters: ExternalPackageFilter, $sort: ExternalPackageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
externalPackages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string",
"withoutContentPackages": "boolean",
"query": "string",
"excludedIds": [
"string"
],
"planIdPlusExternalPackageIds": {
"planId": "string",
"ids": [
"string"
]
},
"notPlanIdPlusExternalPackageIds": {
"planId": "string",
"ids": [
"string"
]
},
"branchPlanIdPlusExternalPackageIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"notBranchPlanIdPlusExternalPackageIds": {
"branchPlanId": "string",
"ids": [
"string"
]
}
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query externalPackages($filters: ExternalPackageFilter, $sort: ExternalPackageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
externalPackages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string",
"withoutContentPackages": "boolean",
"query": "string",
"excludedIds": [
"string"
],
"planIdPlusExternalPackageIds": {
"planId": "string",
"ids": [
"string"
]
},
"notPlanIdPlusExternalPackageIds": {
"planId": "string",
"ids": [
"string"
]
},
"branchPlanIdPlusExternalPackageIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"notBranchPlanIdPlusExternalPackageIds": {
"branchPlanId": "string",
"ids": [
"string"
]
}
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"externalPackages": {
"totalCount": "integer"
}
}
}
Request groups
Returns specific Groups
.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query groups($filters: GroupFilter, $sort: GroupSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
groups(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"query": "string",
"branchId": "string",
"memberId": "string",
"contentPackageId": "string",
"inCourseEventId": "string",
"excludedIds": [
"string"
],
"inCourseEventIdPlusGroupIds": {
"inCourseEventId": "string",
"ids": [
"string"
]
},
"notInCourseEventIdPlusGroupIds": {
"inCourseEventId": "string",
"ids": [
"string"
]
}
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query groups($filters: GroupFilter, $sort: GroupSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
groups(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"query": "string",
"branchId": "string",
"memberId": "string",
"contentPackageId": "string",
"inCourseEventId": "string",
"excludedIds": [
"string"
],
"inCourseEventIdPlusGroupIds": {
"inCourseEventId": "string",
"ids": [
"string"
]
},
"notInCourseEventIdPlusGroupIds": {
"inCourseEventId": "string",
"ids": [
"string"
]
}
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"groups": {
"totalCount": "integer"
}
}
}
Request inCourseEvents
Returns list of InCourseEvent
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query inCourseEvents($filters: InCourseEventFilter, $sort: InCourseEventSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
inCourseEvents(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"query": "string",
"contentPackageTitle": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query inCourseEvents($filters: InCourseEventFilter, $sort: InCourseEventSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
inCourseEvents(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"query": "string",
"contentPackageTitle": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"inCourseEvents": {
"totalCount": "integer"
}
}
}
Request integrations
Returns list of Integration
s.
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query integrations($filters: IntegrationFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
integrations(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"type": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query integrations($filters: IntegrationFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
integrations(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"type": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"integrations": {
"totalCount": "integer"
}
}
}
Request learningHubEvents
Returns list of LearningHubEvent
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query learningHubEvents($filters: LearningHubEventFilter, $sort: LearningHubEventSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
learningHubEvents(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"deliveryType": "string",
"query": "string",
"withRegistrants": [
"string"
],
"excludedIds": [
"string"
],
"slug": "string",
"planIdPlusLearningHubEventIds": {
"planId": "string",
"ids": [
"string"
]
},
"notPlanIdPlusLearningHubEventIds": {
"planId": "string",
"ids": [
"string"
]
},
"branchPlanIdPlusLearningHubEventIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"notBranchPlanIdPlusLearningHubEventIds": {
"branchPlanId": "string",
"ids": [
"string"
]
}
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query learningHubEvents($filters: LearningHubEventFilter, $sort: LearningHubEventSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
learningHubEvents(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"deliveryType": "string",
"query": "string",
"withRegistrants": [
"string"
],
"excludedIds": [
"string"
],
"slug": "string",
"planIdPlusLearningHubEventIds": {
"planId": "string",
"ids": [
"string"
]
},
"notPlanIdPlusLearningHubEventIds": {
"planId": "string",
"ids": [
"string"
]
},
"branchPlanIdPlusLearningHubEventIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"notBranchPlanIdPlusLearningHubEventIds": {
"branchPlanId": "string",
"ids": [
"string"
]
}
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubEvents": {
"totalCount": "integer"
}
}
}
Request learningHubPages
Returns list of LearningHubPage
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query learningHubPages($sort: LearningHubPageSortOrderFilter, $filters: LearningHubPageFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
learningHubPages(sort: $sort, filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"sort": {
"order": "string",
"by": "string"
},
"filters": {
"ids": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query learningHubPages($sort: LearningHubPageSortOrderFilter, $filters: LearningHubPageFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
learningHubPages(sort: $sort, filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"sort": {
"order": "string",
"by": "string"
},
"filters": {
"ids": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubPages": {
"totalCount": "integer"
}
}
}
Request learningPaths
Returns list of LearningPath
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query learningPaths($filters: LearningPathFilter, $sort: LearningPathSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
learningPaths(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"query": "string",
"excludedIds": [
"string"
],
"status": "string",
"branchPlanIdPlusLearningPathIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"notBranchPlanIdPlusLearningPathIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"planIdPlusLearningPathIds": {
"planId": "string",
"ids": [
"string"
]
},
"notPlanIdPlusLearningPathIds": {
"planId": "string",
"ids": [
"string"
]
}
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query learningPaths($filters: LearningPathFilter, $sort: LearningPathSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
learningPaths(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"query": "string",
"excludedIds": [
"string"
],
"status": "string",
"branchPlanIdPlusLearningPathIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"notBranchPlanIdPlusLearningPathIds": {
"branchPlanId": "string",
"ids": [
"string"
]
},
"planIdPlusLearningPathIds": {
"planId": "string",
"ids": [
"string"
]
},
"notPlanIdPlusLearningPathIds": {
"planId": "string",
"ids": [
"string"
]
}
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningPaths": {
"totalCount": "integer"
}
}
}
Request licenses
Returns list of License
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query licenses($filters: LicenseFilter, $sort: LicenseSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
licenses(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"userId": "string",
"branchPlanIds": [
"string"
],
"userQuery": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query licenses($filters: LicenseFilter, $sort: LicenseSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
licenses(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"userId": "string",
"branchPlanIds": [
"string"
],
"userQuery": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"licenses": {
"totalCount": "integer"
}
}
}
Request locales
Returns specific Locales
setup.
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query locales($filters: LocaleFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
locales(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"language": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query locales($filters: LocaleFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
locales(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"language": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"locales": {
"totalCount": "integer"
}
}
}
Request loginTrackings
Returns list of LoginTracking
s.
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query loginTrackings($sort: LoginTrackingSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
loginTrackings(sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query loginTrackings($sort: LoginTrackingSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
loginTrackings(sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"loginTrackings": {
"totalCount": "integer"
}
}
}
Request ltiDeployments
Returns list of LtiDeployments
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query ltiDeployments($filters: LtiDeploymentFilter, $sort: LtiDeploymentSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
ltiDeployments(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"toolId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query ltiDeployments($filters: LtiDeploymentFilter, $sort: LtiDeploymentSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
ltiDeployments(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"toolId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiDeployments": {
"totalCount": "integer"
}
}
}
Request ltiTools
Returns list of LtiTool
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query ltiTools($filters: LtiToolFilter, $sort: LtiToolSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
ltiTools(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"branchId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query ltiTools($filters: LtiToolFilter, $sort: LtiToolSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
ltiTools(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"branchId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiTools": {
"totalCount": "integer"
}
}
}
Request messages
Returns list of Message
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query messages($filters: MessageFilter, $sort: MessageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
messages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
]
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query messages($filters: MessageFilter, $sort: MessageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
messages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
]
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"messages": {
"totalCount": "integer"
}
}
}
Request milestones
Returns list of Milestone
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query milestones($filters: MilestoneFilter, $sort: MilestoneSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
milestones(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query milestones($filters: MilestoneFilter, $sort: MilestoneSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
milestones(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"milestones": {
"totalCount": "integer"
}
}
}
Request permissions
Returns list of Permission
s.
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query permissions($filters: PermissionFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
permissions(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"accessContexts": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query permissions($filters: PermissionFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
permissions(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"accessContexts": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"permissions": {
"totalCount": "integer"
}
}
}
Request plans
Returns list of Plans
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query plans($filters: PlanFilter, $sort: PlanSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
plans(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query plans($filters: PlanFilter, $sort: PlanSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
plans(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"plans": {
"totalCount": "integer"
}
}
}
Request productCategories
Returns list of ProductCategory
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query productCategories($filters: ProductCategoryFilter, $sort: ProductCategorySortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
productCategories(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"childOnly": "boolean"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query productCategories($filters: ProductCategoryFilter, $sort: ProductCategorySortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
productCategories(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"childOnly": "boolean"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"productCategories": {
"totalCount": "integer"
}
}
}
Request productCategoryAssignments
Returns list of ProductCategoryAssignment
s.
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query productCategoryAssignments($filters: ProductCategoryAssignmentFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
productCategoryAssignments(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"forCategorizable": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query productCategoryAssignments($filters: ProductCategoryAssignmentFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
productCategoryAssignments(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"forCategorizable": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"productCategoryAssignments": {
"totalCount": "integer"
}
}
}
Request recognitionTypes
Returns list of RecognitionType
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query recognitionTypes($filters: RecognitionTypeFilter, $sort: RecognitionTypeSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
recognitionTypes(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
]
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query recognitionTypes($filters: RecognitionTypeFilter, $sort: RecognitionTypeSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
recognitionTypes(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
]
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"recognitionTypes": {
"totalCount": "integer"
}
}
}
Request recognitions
Returns list of Recognition
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query recognitions($filters: RecognitionFilter, $sort: RecognitionSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
recognitions(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string",
"learningHubEventId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query recognitions($filters: RecognitionFilter, $sort: RecognitionSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
recognitions(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string",
"learningHubEventId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"recognitions": {
"totalCount": "integer"
}
}
}
Request roles
Returns list of Role
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query roles($sort: RoleSortOrderFilter, $filters: RoleFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
roles(sort: $sort, filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"sort": {
"order": "string",
"by": "string"
},
"filters": {
"ids": [
"string"
],
"notSlugs": [
"string"
],
"query": "string",
"accessContexts": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query roles($sort: RoleSortOrderFilter, $filters: RoleFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
roles(sort: $sort, filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"sort": {
"order": "string",
"by": "string"
},
"filters": {
"ids": [
"string"
],
"notSlugs": [
"string"
],
"query": "string",
"accessContexts": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"roles": {
"totalCount": "integer"
}
}
}
Request studyTasks
Returns list of StudyTask
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query studyTasks($filters: StudyTaskFilter, $sort: StudyTaskSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
studyTasks(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query studyTasks($filters: StudyTaskFilter, $sort: StudyTaskSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
studyTasks(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"contentPackageId": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"studyTasks": {
"totalCount": "integer"
}
}
}
Request subscriptions
Returns list of Subscription
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query subscriptions($filters: SubscriptionFilter, $sort: SubscriptionSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
subscriptions(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"planIds": [
"string"
],
"userQuery": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query subscriptions($filters: SubscriptionFilter, $sort: SubscriptionSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
subscriptions(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"planIds": [
"string"
],
"userQuery": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"subscriptions": {
"totalCount": "integer"
}
}
}
Request urlRegistrations
Returns list of UrlRegistration
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query urlRegistrations($filters: UrlRegistrationFilter, $sort: UrlRegistrationSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
urlRegistrations(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"liveEventId": "string",
"userQuery": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query urlRegistrations($filters: UrlRegistrationFilter, $sort: UrlRegistrationSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
urlRegistrations(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"liveEventId": "string",
"userQuery": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"urlRegistrations": {
"totalCount": "integer"
}
}
}
Request userExternalPackages
Returns list of UserExternalPackage
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query userExternalPackages($filters: UserExternalPackageFilter, $sort: UserExternalPackageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
userExternalPackages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"externalPackageId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query userExternalPackages($filters: UserExternalPackageFilter, $sort: UserExternalPackageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
userExternalPackages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"externalPackageId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userExternalPackages": {
"totalCount": "integer"
}
}
}
Request userRecognitions
Returns list of UserRecognition
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query userRecognitions($filters: UserRecognitionFilter, $sort: UserRecognitionSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
userRecognitions(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"userId": "string",
"recognizableId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query userRecognitions($filters: UserRecognitionFilter, $sort: UserRecognitionSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
userRecognitions(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"userId": "string",
"recognizableId": "string",
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userRecognitions": {
"totalCount": "integer"
}
}
}
Request userRoles
Returns list of UserRole
s.
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query userRoles($filters: UserRoleFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
userRoles(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"userId": "string",
"containedUserIds": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query userRoles($filters: UserRoleFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
userRoles(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"userId": "string",
"containedUserIds": [
"string"
]
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userRoles": {
"totalCount": "integer"
}
}
}
Request users
Returns list of User
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query users($filters: UserFilter, $sort: UserSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
users(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"excludedIds": [
"string"
],
"email": "string",
"name": "string",
"query": "string",
"branchId": "string",
"withoutBranch": "boolean",
"roleSlug": "string",
"withoutRole": "boolean",
"withoutBranchPlanLicense": "string",
"confirmationStatus": "string",
"managersBranchId": "string",
"groupId": "string",
"groupIdPlusUserIds": {
"groupId": "string",
"ids": [
"string"
]
},
"notGroupIdPlusUserIds": {
"groupId": "string",
"ids": [
"string"
]
},
"withoutGroup": "boolean",
"managersGroupId": "string",
"createdAfter": "number",
"createdBefore": "number"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query users($filters: UserFilter, $sort: UserSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
users(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"excludedIds": [
"string"
],
"email": "string",
"name": "string",
"query": "string",
"branchId": "string",
"withoutBranch": "boolean",
"roleSlug": "string",
"withoutRole": "boolean",
"withoutBranchPlanLicense": "string",
"confirmationStatus": "string",
"managersBranchId": "string",
"groupId": "string",
"groupIdPlusUserIds": {
"groupId": "string",
"ids": [
"string"
]
},
"notGroupIdPlusUserIds": {
"groupId": "string",
"ids": [
"string"
]
},
"withoutGroup": "boolean",
"managersGroupId": "string",
"createdAfter": "number",
"createdBefore": "number"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"users": {
"totalCount": "integer"
}
}
}
Request vouchers
Returns list of Voucher
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query vouchers($filters: VoucherFilter, $sort: VoucherSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
vouchers(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"planIds": [
"string"
],
"branchPlanIds": [
"string"
],
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query vouchers($filters: VoucherFilter, $sort: VoucherSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
vouchers(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"planIds": [
"string"
],
"branchPlanIds": [
"string"
],
"query": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"vouchers": {
"totalCount": "integer"
}
}
}
Request webhookDeliveries
Returns list of WebhookDeliveries
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query webhookDeliveries($filters: WebhookDeliveryFilter, $sort: WebhookDeliverySortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
webhookDeliveries(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"webhookIds": [
"string"
],
"webhookEventIds": [
"string"
]
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query webhookDeliveries($filters: WebhookDeliveryFilter, $sort: WebhookDeliverySortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
webhookDeliveries(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"webhookIds": [
"string"
],
"webhookEventIds": [
"string"
]
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"webhookDeliveries": {
"totalCount": "integer"
}
}
}
Request webhookEvents
Returns list of WebhooksEvents
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query webhookEvents($filters: WebhookEventFilter, $sort: WebhookEventSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
webhookEvents(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"eventType": "string",
"startDate": "object",
"endDate": "object"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query webhookEvents($filters: WebhookEventFilter, $sort: WebhookEventSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
webhookEvents(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"eventType": "string",
"startDate": "object",
"endDate": "object"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"webhookEvents": {
"totalCount": "integer"
}
}
}
Request webhooks
Returns list of Webhooks
s.
(no description)
(no description)
Index of the first item in the records to be returned.
Maximum number of records to be returned.
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Example
Request Content-Types:
application/json
Query
query webhooks($filters: WebhookFilter, $sort: WebhookSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
webhooks(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
Variables
{
"filters": {
"ids": [
"string"
],
"query": "string",
"enabled": "boolean",
"eventType": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Try it now
query webhooks($filters: WebhookFilter, $sort: WebhookSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
webhooks(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
totalCount
}
}
{
"filters": {
"ids": [
"string"
],
"query": "string",
"enabled": "boolean",
"eventType": "string"
},
"sort": {
"order": "string",
"by": "string"
},
"offset": "integer",
"limit": "integer",
"after": "string",
"before": "string",
"first": "integer",
"last": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"webhooks": {
"totalCount": "integer"
}
}
}
Mutations
BenchPrep's exposed mutations
Modification branchAssignUsers
Assign Users to Branch
Parameters for BranchAssignUsersMutation
Example
Request Content-Types:
application/json
Query
mutation branchAssignUsers($input: BranchAssignUsersInput!){
branchAssignUsers(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"branchId": "string",
"userIds": [
"string"
]
}
}
Try it now
mutation branchAssignUsers($input: BranchAssignUsersInput!){
branchAssignUsers(input: $input){
clientMutationId
success
}
}
{
"input": {
"branchId": "string",
"userIds": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branchAssignUsers": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification branchCreate
Create Branch
resource.
Parameters for BranchCreateMutation
Example
Request Content-Types:
application/json
Query
mutation branchCreate($input: BranchCreateInput!){
branchCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"externalId": "string",
"parentBranchId": "string"
}
}
Try it now
mutation branchCreate($input: BranchCreateInput!){
branchCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"externalId": "string",
"parentBranchId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branchCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification branchDelete
Delete Branch
resource.
Parameters for BranchDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation branchDelete($input: BranchDeleteInput!){
branchDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation branchDelete($input: BranchDeleteInput!){
branchDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branchDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification branchPlanCreate
Create BranchPlan
resource.
Parameters for BranchPlanCreateMutation
Example
Request Content-Types:
application/json
Query
mutation branchPlanCreate($input: BranchPlanCreateInput!){
branchPlanCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"externalId": "string",
"branchId": "string",
"validFrom": "object",
"validTo": "object",
"duration": "string",
"seatCountType": "string",
"firstActivationDate": "object",
"lastActivationDate": "object",
"finalAccessDate": "object",
"finalAdminAccessDate": "object",
"seatCount": "number",
"concurrentUserLimit": "number",
"enableInBrowse": "boolean",
"contentPackageIds": [
"string"
],
"externalPackageIds": [
"string"
],
"learningHubEventIds": [
"string"
],
"learningPathIds": [
"string"
]
}
}
Try it now
mutation branchPlanCreate($input: BranchPlanCreateInput!){
branchPlanCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"externalId": "string",
"branchId": "string",
"validFrom": "object",
"validTo": "object",
"duration": "string",
"seatCountType": "string",
"firstActivationDate": "object",
"lastActivationDate": "object",
"finalAccessDate": "object",
"finalAdminAccessDate": "object",
"seatCount": "number",
"concurrentUserLimit": "number",
"enableInBrowse": "boolean",
"contentPackageIds": [
"string"
],
"externalPackageIds": [
"string"
],
"learningHubEventIds": [
"string"
],
"learningPathIds": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branchPlanCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification branchPlanUpdate
Update BranchPlan
resource.
Parameters for BranchPlanUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation branchPlanUpdate($input: BranchPlanUpdateInput!){
branchPlanUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"externalId": "string",
"enableInBrowse": "boolean",
"validFrom": "object",
"validTo": "object",
"duration": "number",
"seatCountType": "string",
"firstActivationDate": "object",
"lastActivationDate": "object",
"finalAccessDate": "object",
"finalAdminAccessDate": "object",
"seatCount": "number",
"concurrentUserLimit": "number",
"durationUnit": "string"
}
}
Try it now
mutation branchPlanUpdate($input: BranchPlanUpdateInput!){
branchPlanUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"externalId": "string",
"enableInBrowse": "boolean",
"validFrom": "object",
"validTo": "object",
"duration": "number",
"seatCountType": "string",
"firstActivationDate": "object",
"lastActivationDate": "object",
"finalAccessDate": "object",
"finalAdminAccessDate": "object",
"seatCount": "number",
"concurrentUserLimit": "number",
"durationUnit": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branchPlanUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification branchUpdate
Update Branch
resource.
Parameters for BranchUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation branchUpdate($input: BranchUpdateInput!){
branchUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"externalId": "string",
"slug": "string"
}
}
Try it now
mutation branchUpdate($input: BranchUpdateInput!){
branchUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"externalId": "string",
"slug": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"branchUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification brandingDelete
Delete Branding
resource.
Parameters for DeleteMutation
Example
Request Content-Types:
application/json
Query
mutation brandingDelete($input: BrandingDeleteInput!){
brandingDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"brandableId": "string",
"brandableType": "string"
}
}
Try it now
mutation brandingDelete($input: BrandingDeleteInput!){
brandingDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"brandableId": "string",
"brandableType": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"brandingDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification colorUpdate
Update Color
branding resource.
Parameters for ColorUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation colorUpdate($input: ColorUpdateInput!){
colorUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"primaryColor": "string",
"secondaryColor": "string",
"brandableId": "string",
"brandableType": "string"
}
}
Try it now
mutation colorUpdate($input: ColorUpdateInput!){
colorUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"primaryColor": "string",
"secondaryColor": "string",
"brandableId": "string",
"brandableType": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"colorUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification contentPackageDeactivationDateUpdate
Update deactivation date on ContentPackage
resource
Parameters for ContentPackageUpdateDeactivationDateMutation
Example
Request Content-Types:
application/json
Query
mutation contentPackageDeactivationDateUpdate($input: ContentPackageUpdateDeactivationDateInput!){
contentPackageDeactivationDateUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"deactivatedAt": "object"
}
}
Try it now
mutation contentPackageDeactivationDateUpdate($input: ContentPackageUpdateDeactivationDateInput!){
contentPackageDeactivationDateUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"deactivatedAt": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"contentPackageDeactivationDateUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification developerTokenCreate
Create DeveloperToken
resource.
Parameters for DeveloperTokenCreateMutation
Example
Request Content-Types:
application/json
Query
mutation developerTokenCreate($input: DeveloperTokenCreateInput!){
developerTokenCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string"
}
}
Try it now
mutation developerTokenCreate($input: DeveloperTokenCreateInput!){
developerTokenCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"developerTokenCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification developerTokenDeactivate
Deactivate DeveloperToken
resource.
Parameters for DeveloperTokenDeactivateMutation
Example
Request Content-Types:
application/json
Query
mutation developerTokenDeactivate($input: DeveloperTokenDeactivateInput!){
developerTokenDeactivate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation developerTokenDeactivate($input: DeveloperTokenDeactivateInput!){
developerTokenDeactivate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"developerTokenDeactivate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification developerTokenUpdate
Update DeveloperToken
resource.
Parameters for DeveloperTokenUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation developerTokenUpdate($input: DeveloperTokenUpdateInput!){
developerTokenUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string"
}
}
Try it now
mutation developerTokenUpdate($input: DeveloperTokenUpdateInput!){
developerTokenUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"developerTokenUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification emailTemplateUpdateEnabled
Enable or disabled multiple EmailTemplate
resources in bulk.
Parameters for EmailTemplatesUpdateEnabledMutation
Example
Request Content-Types:
application/json
Query
mutation emailTemplateUpdateEnabled($input: EmailTemplateUpdateInput!){
emailTemplateUpdateEnabled(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"ids": [
"string"
],
"enabled": "boolean"
}
}
Try it now
mutation emailTemplateUpdateEnabled($input: EmailTemplateUpdateInput!){
emailTemplateUpdateEnabled(input: $input){
clientMutationId
success
}
}
{
"input": {
"ids": [
"string"
],
"enabled": "boolean"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"emailTemplateUpdateEnabled": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification enrollmentReset
Reset Enrollment
resource.
Parameters for EnrollmentResetMutation
Example
Request Content-Types:
application/json
Query
mutation enrollmentReset($input: EnrollmentResetMutationInput!){
enrollmentReset(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Try it now
mutation enrollmentReset($input: EnrollmentResetMutationInput!){
enrollmentReset(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"enrollmentReset": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification enrollmentUpdate
Update Enrollment
resource.
Parameters for EnrollmentUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation enrollmentUpdate($input: EnrollmentUpdateInput!){
enrollmentUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"additionalResets": "number"
}
}
Try it now
mutation enrollmentUpdate($input: EnrollmentUpdateInput!){
enrollmentUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"additionalResets": "number"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"enrollmentUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification examResultReset
Reset ExamResult
resource.
Parameters for ExamResultResetMutation
Example
Request Content-Types:
application/json
Query
mutation examResultReset($input: ExamResultResetMutationInput!){
examResultReset(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Try it now
mutation examResultReset($input: ExamResultResetMutationInput!){
examResultReset(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"examResultReset": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification featureAccessUpdate
Update FeatureAccess
resource.
Parameters for FeatureAccessUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation featureAccessUpdate($input: FeatureAccessUpdateInput!){
featureAccessUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"slug": "string",
"allowed": "boolean",
"controllableId": "string",
"controllableType": "string"
}
}
Try it now
mutation featureAccessUpdate($input: FeatureAccessUpdateInput!){
featureAccessUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"slug": "string",
"allowed": "boolean",
"controllableId": "string",
"controllableType": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"featureAccessUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification featureConfigurationUpdate
Update FeatureConfiguration
resource.
Parameters for FeatureConfigurationUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation featureConfigurationUpdate($input: FeatureConfigurationUpdateInput!){
featureConfigurationUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"slug": "string",
"controllableId": "string",
"controllableType": "string",
"configuration": "object"
}
}
Try it now
mutation featureConfigurationUpdate($input: FeatureConfigurationUpdateInput!){
featureConfigurationUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"slug": "string",
"controllableId": "string",
"controllableType": "string",
"configuration": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"featureConfigurationUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification groupCreate
Group
resource.
Parameters for GroupCreateMutation
Example
Request Content-Types:
application/json
Query
mutation groupCreate($input: GroupCreateInput!){
groupCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"branchId": "string",
"externalId": "string",
"description": "string"
}
}
Try it now
mutation groupCreate($input: GroupCreateInput!){
groupCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"branchId": "string",
"externalId": "string",
"description": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"groupCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification groupMembershipUpdate
Update Group
resource membership
Parameters for GroupMembershipUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation groupMembershipUpdate($input: GroupMembershipUpdateInput!){
groupMembershipUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"groupId": "string",
"userIdsToAdd": [
"string"
],
"userIdsToRemove": [
"string"
]
}
}
Try it now
mutation groupMembershipUpdate($input: GroupMembershipUpdateInput!){
groupMembershipUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"groupId": "string",
"userIdsToAdd": [
"string"
],
"userIdsToRemove": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"groupMembershipUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification groupUpdate
Update Group
resource.
Parameters for GroupUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation groupUpdate($input: GroupUpdateInput!){
groupUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"externalId": "string",
"externalSystemId": "string",
"description": "string"
}
}
Try it now
mutation groupUpdate($input: GroupUpdateInput!){
groupUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"externalId": "string",
"externalSystemId": "string",
"description": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"groupUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification groupsCreate
Queue asynchronous process to create multiple Group
resources.
Parameters for GroupsCreateMutation
Example
Request Content-Types:
application/json
Query
mutation groupsCreate($input: GroupsCreateInput!){
groupsCreate(input: $input){
clientMutationId
success
uploadStatus
}
}
Variables
{
"input": {
"fileName": "string",
"dataFormat": "string",
"groups": [
{
"name": "string",
"branchSlug": "string",
"externalId": "string",
"description": "string"
}
]
}
}
Try it now
mutation groupsCreate($input: GroupsCreateInput!){
groupsCreate(input: $input){
clientMutationId
success
uploadStatus
}
}
{
"input": {
"fileName": "string",
"dataFormat": "string",
"groups": [
{
"name": "string",
"branchSlug": "string",
"externalId": "string",
"description": "string"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"groupsCreate": {
"clientMutationId": "string",
"success": "boolean",
"uploadStatus": "string"
}
}
}
Modification inCourseEventCreate
Create InCourseEvent
resource.
Parameters for InCourseEventCreateMutation
Example
Request Content-Types:
application/json
Query
mutation inCourseEventCreate($input: InCourseEventCreateInput!){
inCourseEventCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"archive": "boolean",
"archiveExpiresAt": "object",
"contentPackageId": "string",
"deliveryType": "string",
"description": "string",
"endDate": "object",
"groupIds": [
"string"
],
"isRecognitionIssuing": "boolean",
"name": "string",
"startDate": "object",
"subject": "string",
"url": "string"
}
}
Try it now
mutation inCourseEventCreate($input: InCourseEventCreateInput!){
inCourseEventCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"archive": "boolean",
"archiveExpiresAt": "object",
"contentPackageId": "string",
"deliveryType": "string",
"description": "string",
"endDate": "object",
"groupIds": [
"string"
],
"isRecognitionIssuing": "boolean",
"name": "string",
"startDate": "object",
"subject": "string",
"url": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"inCourseEventCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification inCourseEventDelete
Delete InCourseEvent
resource.
Parameters for InCourseEventDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation inCourseEventDelete($input: InCourseEventDeleteInput!){
inCourseEventDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation inCourseEventDelete($input: InCourseEventDeleteInput!){
inCourseEventDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"inCourseEventDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification inCourseEventUpdate
Update InCourseEvent
resource.
Parameters for InCourseEventUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation inCourseEventUpdate($input: InCourseEventUpdateInput!){
inCourseEventUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"archive": "boolean",
"archiveExpiresAt": "object",
"description": "string",
"embeddedVideoHtml": "string",
"endDate": "object",
"groupIdsToAdd": [
"string"
],
"groupIdsToRemove": [
"string"
],
"id": "string",
"name": "string",
"notesHtml": "string",
"recordingLink": "string",
"startDate": "object",
"url": "string"
}
}
Try it now
mutation inCourseEventUpdate($input: InCourseEventUpdateInput!){
inCourseEventUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"archive": "boolean",
"archiveExpiresAt": "object",
"description": "string",
"embeddedVideoHtml": "string",
"endDate": "object",
"groupIdsToAdd": [
"string"
],
"groupIdsToRemove": [
"string"
],
"id": "string",
"name": "string",
"notesHtml": "string",
"recordingLink": "string",
"startDate": "object",
"url": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"inCourseEventUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification inCourseEventsCreate
Queue asynchronous process to create multiple InCourseEvent
resources.
Parameters for InCourseEventsCreateMutation
Example
Request Content-Types:
application/json
Query
mutation inCourseEventsCreate($input: InCourseEventsCreateInput!){
inCourseEventsCreate(input: $input){
clientMutationId
success
uploadStatus
}
}
Variables
{
"input": {
"fileName": "string",
"dataFormat": "string",
"userTimezone": "string",
"events": [
{
"id": "string",
"archive": "boolean",
"archiveExpiresAt": "object",
"contentPackageId": "string",
"description": "string",
"duration": "number",
"embeddedVideoHtml": "string",
"groupIds": [
"string"
],
"name": "string",
"notesHtml": "string",
"startDate": "object",
"startTime": "string",
"subject": "string",
"url": "string"
}
]
}
}
Try it now
mutation inCourseEventsCreate($input: InCourseEventsCreateInput!){
inCourseEventsCreate(input: $input){
clientMutationId
success
uploadStatus
}
}
{
"input": {
"fileName": "string",
"dataFormat": "string",
"userTimezone": "string",
"events": [
{
"id": "string",
"archive": "boolean",
"archiveExpiresAt": "object",
"contentPackageId": "string",
"description": "string",
"duration": "number",
"embeddedVideoHtml": "string",
"groupIds": [
"string"
],
"name": "string",
"notesHtml": "string",
"startDate": "object",
"startTime": "string",
"subject": "string",
"url": "string"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"inCourseEventsCreate": {
"clientMutationId": "string",
"success": "boolean",
"uploadStatus": "string"
}
}
}
Modification integrationCreate
Create Integration
resource.
Parameters for IntegrationCreateMutation
Example
Request Content-Types:
application/json
Query
mutation integrationCreate($input: IntegrationCreateInput!){
integrationCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"type": "string",
"accountName": "string",
"clientId": "string",
"clientSecret": "string",
"accessToken": "string",
"storeHash": "string"
}
}
Try it now
mutation integrationCreate($input: IntegrationCreateInput!){
integrationCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"type": "string",
"accountName": "string",
"clientId": "string",
"clientSecret": "string",
"accessToken": "string",
"storeHash": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"integrationCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification integrationDelete
Delete Integration
resource.
Parameters for IntegrationDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation integrationDelete($input: IntegrationDeleteMutationInput!){
integrationDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Try it now
mutation integrationDelete($input: IntegrationDeleteMutationInput!){
integrationDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"integrationDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification integrationUpdate
Update Integration
resource.
Parameters for IntegrationUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation integrationUpdate($input: IntegrationUpdateInput!){
integrationUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"accountName": "string"
}
}
Try it now
mutation integrationUpdate($input: IntegrationUpdateInput!){
integrationUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"accountName": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"integrationUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification learnableConfigurationUpdate
Update Learnable Configuration
from a content package
Parameters for LearnableConfigurationUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation learnableConfigurationUpdate($input: LearnableConfigurationUpdateInput!){
learnableConfigurationUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"learnableType": "string",
"learnableId": "string",
"purchaseType": "string",
"purchaseUrl": "string",
"enableInBrowse": "boolean",
"enableDisplayRecognitions": "boolean",
"label": "string",
"externalProductId": "string"
}
}
Try it now
mutation learnableConfigurationUpdate($input: LearnableConfigurationUpdateInput!){
learnableConfigurationUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"learnableType": "string",
"learnableId": "string",
"purchaseType": "string",
"purchaseUrl": "string",
"enableInBrowse": "boolean",
"enableDisplayRecognitions": "boolean",
"label": "string",
"externalProductId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learnableConfigurationUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification learningHubEventCreate
Create LearningHubEvent
resource.
Parameters for LearningHubEventCreateMutation
Example
Request Content-Types:
application/json
Query
mutation learningHubEventCreate($input: LearningHubEventCreateInput!){
learningHubEventCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"description": "string",
"startDate": "object",
"endDate": "object",
"deliveryType": "string",
"hostEmail": "string",
"learnableConfiguration": {
"learnableType": "string",
"purchaseType": "string",
"purchaseUrl": "string",
"enableInBrowse": "boolean",
"enableDisplayRecognitions": "boolean",
"label": "string",
"externalProductId": "string"
},
"isRecognitionIssuing": "boolean",
"slug": "string",
"url": "string"
}
}
Try it now
mutation learningHubEventCreate($input: LearningHubEventCreateInput!){
learningHubEventCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"description": "string",
"startDate": "object",
"endDate": "object",
"deliveryType": "string",
"hostEmail": "string",
"learnableConfiguration": {
"learnableType": "string",
"purchaseType": "string",
"purchaseUrl": "string",
"enableInBrowse": "boolean",
"enableDisplayRecognitions": "boolean",
"label": "string",
"externalProductId": "string"
},
"isRecognitionIssuing": "boolean",
"slug": "string",
"url": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubEventCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification learningHubEventDelete
Delete LearningHubEvent
resource.
Parameters for LearningHubEventDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation learningHubEventDelete($input: LearningHubEventDeleteInput!){
learningHubEventDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation learningHubEventDelete($input: LearningHubEventDeleteInput!){
learningHubEventDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubEventDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification learningHubEventMarketingInfoUpdate
Update Marketing Info for LearningHubEvent
resource.
Parameters for LearningHubEventMarketingInfoUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation learningHubEventMarketingInfoUpdate($input: LearningHubEventMarketingInfoUpdateInput!){
learningHubEventMarketingInfoUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"description": "string",
"base64BannerImage": "string"
}
}
Try it now
mutation learningHubEventMarketingInfoUpdate($input: LearningHubEventMarketingInfoUpdateInput!){
learningHubEventMarketingInfoUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"description": "string",
"base64BannerImage": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubEventMarketingInfoUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification learningHubEventUpdate
Update LearningHubEvent
resource.
Parameters for LearningHubEventUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation learningHubEventUpdate($input: LearningHubEventUpdateInput!){
learningHubEventUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"hostEmail": "string",
"url": "string",
"recordingLink": "string",
"startDate": "object",
"endDate": "object",
"slug": "string"
}
}
Try it now
mutation learningHubEventUpdate($input: LearningHubEventUpdateInput!){
learningHubEventUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"hostEmail": "string",
"url": "string",
"recordingLink": "string",
"startDate": "object",
"endDate": "object",
"slug": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubEventUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification learningHubPageCreate
Create LearningHubPage
resource.
Parameters for LearningHubPageCreateMutation
Example
Request Content-Types:
application/json
Query
mutation learningHubPageCreate($input: LearningHubPageCreateInput!){
learningHubPageCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"pageType": "string",
"html": "string"
}
}
Try it now
mutation learningHubPageCreate($input: LearningHubPageCreateInput!){
learningHubPageCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"pageType": "string",
"html": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubPageCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification learningHubPageDelete
Delete LearningHubPage
resource.
Parameters for LearningHubPageDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation learningHubPageDelete($input: LearningHubPageDeleteInput!){
learningHubPageDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation learningHubPageDelete($input: LearningHubPageDeleteInput!){
learningHubPageDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubPageDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification learningHubPageUpdate
Update LearningHubPage
resource.
Parameters for LearningHubPageUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation learningHubPageUpdate($input: LearningHubPageUpdateInput!){
learningHubPageUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"html": "string",
"name": "string",
"visible": "boolean",
"sortOrder": "number",
"configuration": "object"
}
}
Try it now
mutation learningHubPageUpdate($input: LearningHubPageUpdateInput!){
learningHubPageUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"html": "string",
"name": "string",
"visible": "boolean",
"sortOrder": "number",
"configuration": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubPageUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification learningHubPagesReorder
Reorder all LearningHubPage
resources.
Parameters for LearningHubPagesReorderMutation
Example
Request Content-Types:
application/json
Query
mutation learningHubPagesReorder($input: LearningHubPagesReorderInput!){
learningHubPagesReorder(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"learningHubPages": [
{
"id": "string",
"html": "string",
"name": "string",
"visible": "boolean",
"sortOrder": "number",
"configuration": "object"
}
]
}
}
Try it now
mutation learningHubPagesReorder($input: LearningHubPagesReorderInput!){
learningHubPagesReorder(input: $input){
clientMutationId
success
}
}
{
"input": {
"learningHubPages": [
{
"id": "string",
"html": "string",
"name": "string",
"visible": "boolean",
"sortOrder": "number",
"configuration": "object"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"learningHubPagesReorder": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification licenseCreate
Create License
resource.
Parameters for LicenseCreateMutation
Example
Request Content-Types:
application/json
Query
mutation licenseCreate($input: LicenseCreateInput!){
licenseCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"userIds": [
"string"
],
"branchPlanId": "string",
"planId": "string",
"seatExclusion": "boolean",
"contentPackageId": "string"
}
}
Try it now
mutation licenseCreate($input: LicenseCreateInput!){
licenseCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"userIds": [
"string"
],
"branchPlanId": "string",
"planId": "string",
"seatExclusion": "boolean",
"contentPackageId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"licenseCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification licenseRemove
Invalidate License
resource.
Parameters for LicenseRemoveMutation
Example
Request Content-Types:
application/json
Query
mutation licenseRemove($input: LicenseRemoveMutationInput!){
licenseRemove(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Try it now
mutation licenseRemove($input: LicenseRemoveMutationInput!){
licenseRemove(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"clientMutationId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"licenseRemove": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification licenseUpdate
Update License
resource.
Parameters for LicenseUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation licenseUpdate($input: LicenseUpdateInput!){
licenseUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"validUntil": "object"
}
}
Try it now
mutation licenseUpdate($input: LicenseUpdateInput!){
licenseUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"validUntil": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"licenseUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification localeUpdate
Update Locale
resource.
Parameters for LocaleUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation localeUpdate($input: LocaleUpdateInput!){
localeUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "number",
"overrides": "object"
}
}
Try it now
mutation localeUpdate($input: LocaleUpdateInput!){
localeUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "number",
"overrides": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"localeUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification ltiDeploymentCoursesUpdate
Update LtiDeployment
resource's courses.
Parameters for LtiDeploymentUpdateCoursesMutation
Example
Request Content-Types:
application/json
Query
mutation ltiDeploymentCoursesUpdate($input: LtiDeploymentUpdateCoursesInput!){
ltiDeploymentCoursesUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"contentPackageIdsToAdd": [
"string"
],
"contentPackageIdsToRemove": [
"string"
]
}
}
Try it now
mutation ltiDeploymentCoursesUpdate($input: LtiDeploymentUpdateCoursesInput!){
ltiDeploymentCoursesUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"contentPackageIdsToAdd": [
"string"
],
"contentPackageIdsToRemove": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiDeploymentCoursesUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification ltiDeploymentCreate
Create LtiDeployment
resource.
Parameters for LtiDeploymentCreateMutation
Example
Request Content-Types:
application/json
Query
mutation ltiDeploymentCreate($input: LtiDeploymentCreateInput!){
ltiDeploymentCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"externalId": "string",
"toolId": "string",
"branchId": "string",
"enableNrps": "boolean",
"contentPackageIds": [
"string"
]
}
}
Try it now
mutation ltiDeploymentCreate($input: LtiDeploymentCreateInput!){
ltiDeploymentCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"externalId": "string",
"toolId": "string",
"branchId": "string",
"enableNrps": "boolean",
"contentPackageIds": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiDeploymentCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification ltiDeploymentDelete
Delete LtiDeployment
resource.
Parameters for LtiDeploymentDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation ltiDeploymentDelete($input: LtiDeploymentDeleteInput!){
ltiDeploymentDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation ltiDeploymentDelete($input: LtiDeploymentDeleteInput!){
ltiDeploymentDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiDeploymentDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification ltiDeploymentUpdate
Update Deployment
resource.
Parameters for LtiDeploymentUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation ltiDeploymentUpdate($input: LtiDeploymentUpdateInput!){
ltiDeploymentUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"externalId": "string",
"branchId": "string",
"enableNrps": "boolean",
"ltiContextClaimType": "string"
}
}
Try it now
mutation ltiDeploymentUpdate($input: LtiDeploymentUpdateInput!){
ltiDeploymentUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"externalId": "string",
"branchId": "string",
"enableNrps": "boolean",
"ltiContextClaimType": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiDeploymentUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification ltiToolCreate
Create LtiTool
resource.
Parameters for LtiToolCreateMutation
Example
Request Content-Types:
application/json
Query
mutation ltiToolCreate($input: LtiToolCreateInput!){
ltiToolCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"branchId": "string"
}
}
Try it now
mutation ltiToolCreate($input: LtiToolCreateInput!){
ltiToolCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"branchId": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiToolCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification ltiToolDelete
Delete LtiTool
resource.
Parameters for LtiToolDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation ltiToolDelete($input: LtiToolDeleteInput!){
ltiToolDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation ltiToolDelete($input: LtiToolDeleteInput!){
ltiToolDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiToolDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification ltiToolUpdate
Update LtiTool
resource.
Parameters for LtiToolUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation ltiToolUpdate($input: LtiToolUpdateInput!){
ltiToolUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"clientId": "string",
"keysetUrl": "string",
"oauth2Url": "string",
"oauth2Aud": "string",
"platformOidcAuthUrl": "string",
"roleMapping": "object"
}
}
Try it now
mutation ltiToolUpdate($input: LtiToolUpdateInput!){
ltiToolUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"clientId": "string",
"keysetUrl": "string",
"oauth2Url": "string",
"oauth2Aud": "string",
"platformOidcAuthUrl": "string",
"roleMapping": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"ltiToolUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification marketingPageUpdate
Update MarketingPage
branding resource.
Parameters for MarketingPageUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation marketingPageUpdate($input: PageComponentInput!){
marketingPageUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"variables": "object",
"html": "string",
"isDefault": "boolean"
}
}
Try it now
mutation marketingPageUpdate($input: PageComponentInput!){
marketingPageUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"variables": "object",
"html": "string",
"isDefault": "boolean"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"marketingPageUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification messageCreate
Create Message
resource.
Parameters for MessageCreateMutation
Example
Request Content-Types:
application/json
Query
mutation messageCreate($input: MessageCreateInput!){
messageCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"title": "string",
"body": "string",
"contentPackageId": "string",
"userSegment": {
"components": [
{
"componentId": "string",
"componentType": "string",
"accessContextId": "string",
"accessContextType": "string"
}
]
},
"startDate": "object",
"endDate": "object",
"eventTrigger": {
"eventType": "string",
"contentLocation": "string",
"enabled": "boolean"
}
}
}
Try it now
mutation messageCreate($input: MessageCreateInput!){
messageCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"title": "string",
"body": "string",
"contentPackageId": "string",
"userSegment": {
"components": [
{
"componentId": "string",
"componentType": "string",
"accessContextId": "string",
"accessContextType": "string"
}
]
},
"startDate": "object",
"endDate": "object",
"eventTrigger": {
"eventType": "string",
"contentLocation": "string",
"enabled": "boolean"
}
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"messageCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification messageDelete
Delete Message
resource.
Parameters for MessageDeleteMutation
Example
Request Content-Types:
application/json
Query
mutation messageDelete($input: MessageDeleteInput!){
messageDelete(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string"
}
}
Try it now
mutation messageDelete($input: MessageDeleteInput!){
messageDelete(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"messageDelete": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification messageUpdate
Update Message
resource.
Parameters for MessageUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation messageUpdate($input: MessageUpdateInput!){
messageUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"title": "string",
"body": "string",
"contentPackageId": "string",
"startDate": "object",
"endDate": "object",
"eventTrigger": {
"eventType": "string",
"contentLocation": "string",
"enabled": "boolean"
}
}
}
Try it now
mutation messageUpdate($input: MessageUpdateInput!){
messageUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"title": "string",
"body": "string",
"contentPackageId": "string",
"startDate": "object",
"endDate": "object",
"eventTrigger": {
"eventType": "string",
"contentLocation": "string",
"enabled": "boolean"
}
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"messageUpdate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification planCreate
Create Plan
resource.
Parameters for PlanCreateMutation
Example
Request Content-Types:
application/json
Query
mutation planCreate($input: PlanCreateInput!){
planCreate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"name": "string",
"slug": "string",
"externalId": "string",
"validFrom": "string",
"validTo": "string",
"durationUnit": "string",
"duration": "string",
"finalAccessDate": "string",
"firstActivationDate": "object",
"kind": "string",
"contentPackageIds": [
"string"
],
"learningHubEventIds": [
"string"
],
"externalPackageIds": [
"string"
],
"learningPathIds": [
"string"
],
"planType": "string"
}
}
Try it now
mutation planCreate($input: PlanCreateInput!){
planCreate(input: $input){
clientMutationId
success
}
}
{
"input": {
"name": "string",
"slug": "string",
"externalId": "string",
"validFrom": "string",
"validTo": "string",
"durationUnit": "string",
"duration": "string",
"finalAccessDate": "string",
"firstActivationDate": "object",
"kind": "string",
"contentPackageIds": [
"string"
],
"learningHubEventIds": [
"string"
],
"externalPackageIds": [
"string"
],
"learningPathIds": [
"string"
],
"planType": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"planCreate": {
"clientMutationId": "string",
"success": "boolean"
}
}
}
Modification planUpdate
Update Plan
resource.
Parameters for PlanUpdateMutation
Example
Request Content-Types:
application/json
Query
mutation planUpdate($input: PlanUpdateInput!){
planUpdate(input: $input){
clientMutationId
success
}
}
Variables
{
"input": {
"id": "string",
"name": "string",
"slug": "string",
"externalId": "string",
"validFrom": "string",
"validTo": "string",
"durationUnit": "string",
"duration": "number",
"finalAccessDate": "string",
"firstActivationDate": "string"
}
}
Try it now
mutation planUpdate($input: PlanUpdateInput!){
planUpdate(input: $input){
clientMutationId
success
}
}
{
"input": {
"id": "string",
"name": "string",
"slug": "string",
"externalId": "string",
"validFrom": "string",
"validTo": "string",
"durationUnit": "string",
"duration": "number",
"finalAccessDate": "string",
"firstActivationDate": "string"
}
}