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 bannerMessages

Returns list of BannerMessagess.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json
Query
query bannerMessages($filters: BannerMessageFilter, $sort: BannerMessageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  bannerMessages(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",
    "destination": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "bannerMessages": {
      "totalCount": "integer"
    }
  }
}

Request branchPlans

Returns list of BranchPlanss.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "branchPlans": {
      "totalCount": "integer"
    }
  }
}

Request branches

Returns specific Branches.

filters:

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
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
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 Certificates.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "certificates": {
      "totalCount": "integer"
    }
  }
}

Request contentPackages

Returns list of ContentPackages.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "contentPackages": {
      "totalCount": "integer"
    }
  }
}

Request contentTypes

Returns list of ContentTypes.

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
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{
    id
    name
    publicUrl
    slug
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "currentTenant": {
      "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
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
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 DeveloperTokenss.

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "developerTokens": {
      "totalCount": "integer"
    }
  }
}

Request domains

Returns registered Domains (resolver) to the current tenant.

filters:

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "domains": {
      "totalCount": "integer"
    }
  }
}

Request enrollments

Returns list of Enrollments.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "enrollments": {
      "totalCount": "integer"
    }
  }
}

Request examResults

Returns list of ExamResults.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "examResults": {
      "totalCount": "integer"
    }
  }
}

Request exams

Returns list of Exams.

filters:

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "exams": {
      "totalCount": "integer"
    }
  }
}

Request externalPackages

Returns list of ExternalPackages.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "externalPackages": {
      "totalCount": "integer"
    }
  }
}

Request groups

Returns specific Groups.

filters:

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "groups": {
      "totalCount": "integer"
    }
  }
}

Request integrations

Returns list of Integrations.

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "integrations": {
      "totalCount": "integer"
    }
  }
}

Request learningHubEvents

Returns list of LearningHubEvents.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "learningHubEvents": {
      "totalCount": "integer"
    }
  }
}

Request learningHubPages

Returns list of LearningHubPages.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "learningHubPages": {
      "totalCount": "integer"
    }
  }
}

Request learningPaths

Returns list of LearningPaths.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "learningPaths": {
      "totalCount": "integer"
    }
  }
}

Request licenses

Returns list of Licenses.

filters:

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "licenses": {
      "totalCount": "integer"
    }
  }
}

Request locales

Returns specific Locales setup.

filters:

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "locales": {
      "totalCount": "integer"
    }
  }
}

Request loginTrackings

Returns list of LoginTrackings.

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "loginTrackings": {
      "totalCount": "integer"
    }
  }
}

Request ltiDeployments

Returns list of LtiDeploymentss.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "ltiDeployments": {
      "totalCount": "integer"
    }
  }
}

Request ltiTools

Returns list of LtiTools.

filters:

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "ltiTools": {
      "totalCount": "integer"
    }
  }
}

Request messages

Returns list of Messages.

filters:

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "messages": {
      "totalCount": "integer"
    }
  }
}

Request milestones

Returns list of Milestones.

filters:

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "milestones": {
      "totalCount": "integer"
    }
  }
}

Request permissions

Returns list of Permissions.

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "permissions": {
      "totalCount": "integer"
    }
  }
}

Request plans

Returns list of Planss.

filters:

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "plans": {
      "totalCount": "integer"
    }
  }
}

Request productCategories

Returns list of ProductCategorys.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "productCategories": {
      "totalCount": "integer"
    }
  }
}

Request productCategoryAssignments

Returns list of ProductCategoryAssignments.

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "productCategoryAssignments": {
      "totalCount": "integer"
    }
  }
}

Request recognitionTypes

Returns list of RecognitionTypes.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "recognitionTypes": {
      "totalCount": "integer"
    }
  }
}

Request recognitions

Returns list of Recognitions.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "recognitions": {
      "totalCount": "integer"
    }
  }
}

Request roles

Returns list of Roles.

(no description)

filters:

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "roles": {
      "totalCount": "integer"
    }
  }
}

Request standardTags

Returns list of StandardTags.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json
Query
query standardTags($filters: StandardTagFilter, $sort: StandardTagSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  standardTags(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}
Variables
{
  "filters": {
    "ids": [
      "string"
    ],
    "rootOnly": "boolean",
    "parentId": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "standardTags": {
      "totalCount": "integer"
    }
  }
}

Request studyTasks

Returns list of StudyTasks.

filters:

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "studyTasks": {
      "totalCount": "integer"
    }
  }
}

Request subscriptions

Returns list of Subscriptions.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "subscriptions": {
      "totalCount": "integer"
    }
  }
}

Request userExternalPackages

Returns list of UserExternalPackages.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "userExternalPackages": {
      "totalCount": "integer"
    }
  }
}

Request userRecognitions

Returns list of UserRecognitions.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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",
    "contentPackageId": "string",
    "query": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "userRecognitions": {
      "totalCount": "integer"
    }
  }
}

Request userRoles

Returns list of UserRoles.

filters:

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "userRoles": {
      "totalCount": "integer"
    }
  }
}

Request users

Returns list of Users.

filters:

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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",
    "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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "users": {
      "totalCount": "integer"
    }
  }
}

Request vouchers

Returns list of Vouchers.

filters:

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "vouchers": {
      "totalCount": "integer"
    }
  }
}

Request webhookDeliveries

Returns list of WebhookDeliveriess.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "webhookDeliveries": {
      "totalCount": "integer"
    }
  }
}

Request webhookEvents

Returns list of WebhooksEventss.

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "webhookEvents": {
      "totalCount": "integer"
    }
  }
}

Request webhooks

Returns list of Webhookss.

filters:

(no description)

(no description)

offset:
integer

Index of the first item in the records to be returned.

limit:
integer

Maximum number of records to be returned.

after:
string

Returns the elements in the list that come after the specified cursor.

before:
string

Returns the elements in the list that come before the specified cursor.

first:
integer

Returns the first n elements from the list.

last:
integer

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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "webhooks": {
      "totalCount": "integer"
    }
  }
}

Mutations

BenchPrep's exposed mutations

Modification bannerMessageCreate

Create BannerMessage resource.

Parameters for BannerMessageCreateMutation

Example

Request Content-Types: application/json
Query
mutation bannerMessageCreate($input: BannerMessageCreateInput!){
  bannerMessageCreate(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "name": "string",
    "body": "string",
    "startDate": "object",
    "endDate": "object",
    "destinations": [
      "string"
    ],
    "contentPackageId": "string",
    "userSegment": {
      "components": [
        {
          "componentId": "string",
          "componentType": "string",
          "accessContextId": "string",
          "accessContextType": "string"
        }
      ]
    },
    "eventTrigger": {
      "eventType": "string",
      "contentLocation": "string",
      "enabled": "boolean"
    }
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "bannerMessageCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification bannerMessageDelete

Delete BannerMessage resource.

Parameters for BannerMessageDeleteMutation

Example

Request Content-Types: application/json
Query
mutation bannerMessageDelete($input: BannerMessageDeleteInput!){
  bannerMessageDelete(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "id": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "bannerMessageDelete": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification bannerMessageUpdate

Update BannerMessage resource.

Parameters for BannerMessageUpdateMutation

Example

Request Content-Types: application/json
Query
mutation bannerMessageUpdate($input: BannerMessageUpdateInput!){
  bannerMessageUpdate(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "id": "string",
    "name": "string",
    "body": "string",
    "destinations": [
      "string"
    ],
    "contentPackageId": "string",
    "startDate": "object",
    "endDate": "object",
    "eventTrigger": {
      "eventType": "string",
      "contentLocation": "string",
      "enabled": "boolean"
    }
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "bannerMessageUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

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
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
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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "branchDelete": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification branchPlanCoursesUpdate

Update BranchPlan resource's courses.

Parameters for BranchPlanUpdateCoursesMutation

Example

Request Content-Types: application/json
Query
mutation branchPlanCoursesUpdate($input: BranchPlanUpdateCoursesInput!){
  branchPlanCoursesUpdate(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "id": "string",
    "contentPackageIdsToAdd": [
      "string"
    ],
    "contentPackageIdsToRemove": [
      "string"
    ],
    "updateExistingUsers": "boolean"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "branchPlanCoursesUpdate": {
      "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"
    ]
  }
}
Try it now
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
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
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
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
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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "contentPackageDeactivationDateUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification contentPackageNavigationItemsUpdate

Update NavigationItem resources.

Parameters for ContentPackageNavigationItemsUpdateMutation

Example

Request Content-Types: application/json
Query
mutation contentPackageNavigationItemsUpdate($input: ContentPackageNavigationItemsUpdateInput!){
  contentPackageNavigationItemsUpdate(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "id": "string",
    "items": [
      {
        "itemType": "string",
        "landingPage": "boolean",
        "sortOrder": "number",
        "visible": "boolean",
        "configuration": "object"
      }
    ]
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "contentPackageNavigationItemsUpdate": {
      "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
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
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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "developerTokenUpdate": {
      "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
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
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
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
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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "featureConfigurationUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification footerUpdate

Update Footer branding resource.

Parameters for FooterUpdateMutation

Example

Request Content-Types: application/json
Query
mutation footerUpdate($input: PageComponentInput!){
  footerUpdate(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "id": "string",
    "variables": "object",
    "html": "string",
    "isDefault": "boolean"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "footerUpdate": {
      "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
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
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
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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "groupsCreate": {
      "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"
  }
}
Try it now
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
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
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"
  }
}
Try it now
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",
      "label": "string"
    },
    "url": "string",
    "password": "string",
    "hostVideo": "boolean",
    "participantVideo": "boolean",
    "audio": "string",
    "joinBeforeHost": "boolean",
    "muteUponEntry": "boolean",
    "waitingRoom": "boolean",
    "autoRecording": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "learningHubEventCreate": {
      "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
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
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
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
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"
  }
}
Try it now
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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"
    ],
    "planType": "string"
  }
}
Try it now
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
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "planUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification planUpdateAuthorizations

Update Plans authorizations.

Parameters for PlanUpdateAuthorizationsMutation

Example

Request Content-Types: application/json
Query
mutation planUpdateAuthorizations($input: PlanUpdateAuthorizationsInput!){
  planUpdateAuthorizations(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "id": "string",
    "contentPackageIdsToAdd": [
      "string"
    ],
    "contentPackageIdsToRemove": [
      "string"
    ],
    "updateExistingUsers": "boolean"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "planUpdateAuthorizations": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification productCategoryAssignmentsUpdate

Update ProductCategoryAssignment resource for a product.

Parameters for ProductCategoryAssignmentsUpdateMutation

Example

Request Content-Types: application/json
Query
mutation productCategoryAssignmentsUpdate($input: ProductCategoryAssignmentsUpdateInput!){
  productCategoryAssignmentsUpdate(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "categorizableId": "string",
    "categorizableType": "string",
    "productCategoryIds": [
      "string"
    ]
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "productCategoryAssignmentsUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification recognitionTypeCreate

Create RecognitionType resource.

Parameters for RecognitionTypeCreateMutation

Example

Request Content-Types: application/json
Query
mutation recognitionTypeCreate($input: RecognitionTypeCreateInput!){
  recognitionTypeCreate(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "name": "string",
    "awardType": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "recognitionTypeCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification recognitionTypeDelete

Delete RecognitionType resource.

Parameters for RecognitionTypeDeleteMutation

Example

Request Content-Types: application/json
Query
mutation recognitionTypeDelete($input: RecognitionTypeDeleteInput!){
  recognitionTypeDelete(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "id": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "recognitionTypeDelete": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification recognitionTypeUpdate

Update RecognitionType resource.

Parameters for RecognitionTypeUpdateMutation

Example

Request Content-Types: application/json
Query
mutation recognitionTypeUpdate($input: RecognitionTypeUpdateInput!){
  recognitionTypeUpdate(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "id": "string",
    "name": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "recognitionTypeUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification roleCreate

Create Role resource.

Parameters for RoleCreateMutation

Example

Request Content-Types: application/json
Query
mutation roleCreate($input: RoleCreateInput!){
  roleCreate(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "slug": "string",
    "name": "string",
    "permissionSlugs": [
      "string"
    ],
    "description": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "roleCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification roleDelete

Delete Role resource.

Parameters for RoleDeleteMutation

Example

Request Content-Types: application/json
Query
mutation roleDelete($input: RoleDeleteMutationInput!){
  roleDelete(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "id": "string",
    "clientMutationId": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "roleDelete": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification roleUpdate

Update Role resource.

Parameters for RoleUpdateMutation

Example

Request Content-Types: application/json
Query
mutation roleUpdate($input: RoleUpdateInput!){
  roleUpdate(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "id": "string",
    "name": "string",
    "description": "string",
    "permissionSlugs": [
      "string"
    ]
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "roleUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification standardTagCreate

Create StandardTag resource.

Parameters for StandardTagCreateMutation

Example

Request Content-Types: application/json
Query
mutation standardTagCreate($input: StandardTagCreateInput!){
  standardTagCreate(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "name": "string",
    "code": "string",
    "parentId": "string",
    "displayOnWebapp": "boolean",
    "displayOnLearningHub": "boolean"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "standardTagCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification subscriptionCreate

Deprecated by VoucherRedemption mutation

Create Subscription resource.

Parameters for SubscriptionCreateMutation

Example

Request Content-Types: application/json
Query
mutation subscriptionCreate($input: SubscriptionCreateInput!){
  subscriptionCreate(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "userId": "string",
    "voucherToken": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "subscriptionCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification userActivate

Activate User resource.

Parameters for UserActivateMutation

Example

Request Content-Types: application/json
Query
mutation userActivate($input: UserActivateMutationInput!){
  userActivate(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "id": "string",
    "clientMutationId": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "userActivate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification userCreate

Create User resource.

Parameters for UserCreateMutation

Example

Request Content-Types: application/json
Query
mutation userCreate($input: UserCreateInput!){
  userCreate(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "name": "string",
    "email": "string",
    "sisId": "string",
    "password": "string",
    "passwordConfirmation": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "userCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification userDeactivate

Deactivate User resource.

Parameters for UserDeactivateMutation

Example

Request Content-Types: application/json
Query
mutation userDeactivate($input: UserDeactivateMutationInput!){
  userDeactivate(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "id": "string",
    "clientMutationId": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "userDeactivate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification userRemoveGroups

Remove User from all associated Groups.

Parameters for UserRemoveGroupsMutation

Example

Request Content-Types: application/json
Query
mutation userRemoveGroups($input: UserRemoveGroupsInput!){
  userRemoveGroups(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "id": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "userRemoveGroups": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification userRoleCreate

Create UserRole resource.

Parameters for UserRoleCreateMutation

Example

Request Content-Types: application/json
Query
mutation userRoleCreate($input: UserRoleCreateInput!){
  userRoleCreate(input: $input){
    clientMutationId
    creationGuard
    success
  }
}
Variables
{
  "input": {
    "userId": "string",
    "roleSlug": "string",
    "accessContextType": "string",
    "accessContextId": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "userRoleCreate": {
      "clientMutationId": "string",
      "creationGuard": "string",
      "success": "boolean"
    }
  }
}

Modification userRoleDelete

Delete UserRole resource.

Parameters for UserRoleDeleteMutation

Example

Request Content-Types: application/json
Query
mutation userRoleDelete($input: UserRoleDeleteMutationInput!){
  userRoleDelete(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "id": "string",
    "clientMutationId": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "userRoleDelete": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification userRoleUpdate

Update UserRole resource.

Parameters for UserRoleUpdateMutation

Example

Request Content-Types: application/json
Query
mutation userRoleUpdate($input: UserRoleUpdateInput!){
  userRoleUpdate(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "id": "string",
    "properties": "object"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "userRoleUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Modification userRolesCreate

Create multiple UserRole resources in bulk.

Parameters for UserRolesCreateMutation

Example

Request Content-Types: application/json
Query
mutation userRolesCreate($input: UserRolesCreateInput!){
  userRolesCreate(input: $input){
    clientMutationId
    success
  }
}
Variables
{
  "input": {
    "roleSlug": "string",
    "userIds": [
      "string"
    ],
    "accessContextType": "string",
    "accessContextId": "string"
  }
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "userRolesCreate": {