Mentorly GraphQL API
The Mentorly GraphQL API gives programmatic access to the full mentoring lifecycle: onboarding, availability, matching, session booking, messaging, goals, reviews, and program analytics. It is the same API the Mentorly web application runs on, so anything a user can do in the product, an authorized API consumer (including an AI agent acting on that user's behalf) can do through this API.
All requests are POSTs to the single /graphql endpoint with a JSON body containing query, optional operationName, and optional variables.
API Endpoints
# Production:
https://api.mentorly.co/graphql
Authentication
Authenticate with an API key in the Authorization header:
Authorization: Bearer mk_live_<prefix>.<secret>
API keys are issued by Mentorly administrators. Contact your Mentorly account manager or support@mentorly.co to request one. The plaintext key is shown once at creation and cannot be recovered; store it in a secret manager.
Keys act as a user. A key is bound to a Mentorly user and the request behaves exactly as if that user were logged in. The permission system enforces what that user can do: a key bound to a program manager can manage their entire program; a key bound to a mentee can book sessions and message mentors.
Scopes are a ceiling, not a grant. A key also carries scopes (read:users, write:users, read:bookings, write:bookings, read:matches, write:matches, read:analytics, read:conversations, admin). They cap what the key may do on top of the user's own permissions. A key with only read:bookings cannot mutate anything, even if the user could in the web app. Attempting an operation beyond the key's scopes returns a GraphQL error with extensions.code = "forbidden".
Group context. Program-scoped queries resolve against the group (program) in context. Web clients pass an X-Group-Id: <id> header; API-key requests fall back to the key's configured group when the header is absent. Pass the header explicitly when the user belongs to more than one program.
Rate limits
Each API key has its own quota, independent of source IP:
| Tier | Limit |
|---|---|
| Standard | 120 requests / minute / key |
| Enterprise | 600 requests / minute / key |
Successful API-key responses include X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers. When a limit is exceeded the API returns HTTP 429 with a Retry-After header; back off until the reset time before retrying.
Browser (JWT) traffic is limited separately at 300 requests / minute / user, so API consumers never compete with web users for quota.
Errors
Errors surface in two places, and consumers should handle both:
Top-level GraphQL errors (errors array in the response): request-level failures such as authorization or validation problems. Each error carries a machine-readable extensions.code:
| Code | Meaning |
|---|---|
VALIDATION_ERROR |
Input failed model validation; extensions.details lists messages |
unauthorized |
The authenticated identity may not perform this operation |
forbidden |
The API key's scopes do not allow this operation |
NOT_FOUND_ERROR |
The referenced resource does not exist |
Mutation-level errors: every mutation payload also exposes errors: [String] and errorDetails: JSON fields for business-rule failures that are part of the normal flow (for example, a booking outside the mentor's availability). A 200 response with content in the mutation's errors field is a handled failure, not success.
Pagination
List fields accept page and per arguments (1-indexed pages). The default and maximum page size is 20 items unless a field documents otherwise. Request successive pages until a page returns fewer than per items.
Query constraints
| Constraint | Value |
|---|---|
| Maximum query depth | 15 |
| Maximum query complexity | 1000 |
| Maximum page size | 20 |
Queries exceeding depth or complexity limits are rejected with a top-level error. Prefer several focused queries over one deeply nested query.
For AI agents
This API is designed to be driven by AI agents acting on behalf of a user via a user-delegated API key. Schema introspection is disabled in production; this reference is generated from the same schema and every operation below carries a description. Treat the key holder's permissions and the key's scopes as the boundary of what your agent may do, and respect Retry-After on 429 responses.
Queries
activeDiscount
Description
The currently active marketing discount, if any.
Response
Returns a Discount
Example
Query
query activeDiscount {
activeDiscount {
cta
endTime
id
message
startTime
}
}
Response
{
"data": {
"activeDiscount": {
"cta": "abc123",
"endTime": ISO8601DateTime,
"id": "4",
"message": "abc123",
"startTime": ISO8601DateTime
}
}
}
apiKeys
Description
List API keys for an account. Mentorly admins only.
Response
Returns [ApiKey!]!
Arguments
| Name | Description |
|---|---|
accountId - ID!
|
Example
Query
query apiKeys($accountId: ID!) {
apiKeys(accountId: $accountId) {
account {
...AccountFragment
}
active
createdAt
expiresAt
groupIds
id
keyPrefix
lastUsedAt
name
rateLimitTier
scopes
user {
...ManagedUserFragment
}
}
}
Variables
{"accountId": 4}
Response
{
"data": {
"apiKeys": [
{
"account": Account,
"active": true,
"createdAt": ISO8601DateTime,
"expiresAt": ISO8601DateTime,
"groupIds": ["4"],
"id": "4",
"keyPrefix": "abc123",
"lastUsedAt": ISO8601DateTime,
"name": "xyz789",
"rateLimitTier": "abc123",
"scopes": ["xyz789"],
"user": ManagedUser
}
]
}
}
benefitContents
Description
Marketing benefit blocks for the public website.
Response
Returns [BenefitContent!]!
Example
Query
query benefitContents {
benefitContents {
body
id
imageUrl
key
title
}
}
Response
{
"data": {
"benefitContents": [
{
"body": "xyz789",
"id": "4",
"imageUrl": "abc123",
"key": "4",
"title": "xyz789"
}
]
}
}
blogContent
Description
Blog Content
Response
Returns a BlogContent
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query blogContent($id: ID!) {
blogContent(id: $id) {
body
bodyHtml
categories
description
id
key
publishedAt
title
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"blogContent": {
"body": "xyz789",
"bodyHtml": "xyz789",
"categories": ["xyz789"],
"description": "xyz789",
"id": 4,
"key": "4",
"publishedAt": ISO8601DateTime,
"title": "abc123",
"updatedAt": ISO8601DateTime
}
}
}
blogContents
Description
All blog post entries for the public website.
Response
Returns [BlogContent!]
Example
Query
query blogContents {
blogContents {
body
bodyHtml
categories
description
id
key
publishedAt
title
updatedAt
}
}
Response
{
"data": {
"blogContents": [
{
"body": "abc123",
"bodyHtml": "xyz789",
"categories": ["xyz789"],
"description": "xyz789",
"id": "4",
"key": "4",
"publishedAt": ISO8601DateTime,
"title": "xyz789",
"updatedAt": ISO8601DateTime
}
]
}
}
booking
Description
A single booking by id. Visible only to its participants.
Example
Query
query booking($id: ID!) {
booking(id: $id) {
calendarLinks {
...CalendarLinkFragment
}
cancellationReason
conferenceUrl
conversation {
...ConversationFragment
}
createdAt
defaultTitle
description
duration
endTime
group {
...GroupFragment
}
groupSession
guests {
...UserFragment
}
hosts {
...UserFragment
}
id
isExternalBooking
isFull
isMentor
isParticipating
isRequest
jitsiRoomId
jitsiToken
lastReviewByViewer {
...ReviewFragment
}
location {
...LocationFragment
}
maxParticipants
mentee {
...UserFragment
}
mentor {
...UserFragment
}
minParticipants
otherGuests {
...UserFragment
}
otherParticipants {
...UserFragment
}
participants {
...UserFragment
}
participations {
...BookingParticipationFragment
}
pid
sessionType
startTime
status
syncedToCalendar
title
type
}
}
Variables
{"id": "4"}
Response
{
"data": {
"booking": {
"calendarLinks": [CalendarLink],
"cancellationReason": "abc123",
"conferenceUrl": "xyz789",
"conversation": Conversation,
"createdAt": ISO8601DateTime,
"defaultTitle": "abc123",
"description": "abc123",
"duration": 123,
"endTime": ISO8601DateTime,
"group": Group,
"groupSession": true,
"guests": [User],
"hosts": [User],
"id": 4,
"isExternalBooking": false,
"isFull": true,
"isMentor": false,
"isParticipating": true,
"isRequest": false,
"jitsiRoomId": "abc123",
"jitsiToken": "abc123",
"lastReviewByViewer": Review,
"location": Location,
"maxParticipants": 123,
"mentee": User,
"mentor": User,
"minParticipants": 123,
"otherGuests": [User],
"otherParticipants": [User],
"participants": [User],
"participations": [BookingParticipation],
"pid": "4",
"sessionType": "xyz789",
"startTime": ISO8601DateTime,
"status": "abc123",
"syncedToCalendar": true,
"title": "abc123",
"type": "booking"
}
}
}
careerDevelopmentRecommendations
Description
Career development recommendations for mentees in a group
Response
Example
Query
query careerDevelopmentRecommendations(
$groupId: ID!,
$locale: String
) {
careerDevelopmentRecommendations(
groupId: $groupId,
locale: $locale
) {
metadata {
...AnalysisMetadataFragment
}
recommendations {
...CareerDevelopmentRecommendationFragment
}
summary
}
}
Variables
{"groupId": "4", "locale": "en"}
Response
{
"data": {
"careerDevelopmentRecommendations": {
"metadata": AnalysisMetadata,
"recommendations": [
CareerDevelopmentRecommendation
],
"summary": "abc123"
}
}
}
companyValueContents
Description
Marketing company-value blocks for the public website.
Response
Returns [CompanyValueContent!]!
Example
Query
query companyValueContents {
companyValueContents {
description
id
imageUrl
key
title
valueType
}
}
Response
{
"data": {
"companyValueContents": [
{
"description": "abc123",
"id": "4",
"imageUrl": "xyz789",
"key": 4,
"title": "xyz789",
"valueType": "4"
}
]
}
}
conversation
Description
A single conversation by id. Visible to its members.
Response
Returns a Conversation!
Arguments
| Name | Description |
|---|---|
id - ID
|
Example
Query
query conversation($id: ID) {
conversation(id: $id) {
events {
... on Message {
...MessageFragment
}
... on MessageDeletion {
...MessageDeletionFragment
}
... on Upload {
...UploadFragment
}
}
groupConversation
id
internalId
isAnnouncement
isFiltering
lastEventAt
lastVisitedAt
memberCount
memberFilters {
...MemberFiltersFragment
}
members {
...UserFragment
}
memberships {
...ConversationMembershipFragment
}
messageCursor
messages {
...MessageFragment
}
name
otherMembers {
...UserFragment
}
otherMembersCount
otherRecipients {
...UserFragment
}
recipientIds
recipients {
...UserFragment
}
sender {
...UserFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"conversation": {
"events": [Message],
"groupConversation": false,
"id": 4,
"internalId": 4,
"isAnnouncement": false,
"isFiltering": true,
"lastEventAt": ISO8601DateTime,
"lastVisitedAt": ISO8601DateTime,
"memberCount": 123,
"memberFilters": MemberFilters,
"members": [User],
"memberships": [ConversationMembership],
"messageCursor": 4,
"messages": [Message],
"name": "abc123",
"otherMembers": [User],
"otherMembersCount": 123,
"otherRecipients": [User],
"recipientIds": [4],
"recipients": [User],
"sender": User
}
}
}
conversationCount
Description
Count of the viewer's conversations matching the given filter.
conversations
Description
Paginated list of the viewer's conversations.
Response
Returns [Conversation!]!
Example
Query
query conversations(
$page: Int,
$per: Int,
$query: String
) {
conversations(
page: $page,
per: $per,
query: $query
) {
events {
... on Message {
...MessageFragment
}
... on MessageDeletion {
...MessageDeletionFragment
}
... on Upload {
...UploadFragment
}
}
groupConversation
id
internalId
isAnnouncement
isFiltering
lastEventAt
lastVisitedAt
memberCount
memberFilters {
...MemberFiltersFragment
}
members {
...UserFragment
}
memberships {
...ConversationMembershipFragment
}
messageCursor
messages {
...MessageFragment
}
name
otherMembers {
...UserFragment
}
otherMembersCount
otherRecipients {
...UserFragment
}
recipientIds
recipients {
...UserFragment
}
sender {
...UserFragment
}
}
}
Variables
{"page": 987, "per": 987, "query": "xyz789"}
Response
{
"data": {
"conversations": [
{
"events": [Message],
"groupConversation": false,
"id": 4,
"internalId": "4",
"isAnnouncement": true,
"isFiltering": false,
"lastEventAt": ISO8601DateTime,
"lastVisitedAt": ISO8601DateTime,
"memberCount": 123,
"memberFilters": MemberFilters,
"members": [User],
"memberships": [ConversationMembership],
"messageCursor": "4",
"messages": [Message],
"name": "xyz789",
"otherMembers": [User],
"otherMembersCount": 123,
"otherRecipients": [User],
"recipientIds": ["4"],
"recipients": [User],
"sender": User
}
]
}
}
countries
Description
Countries
Response
Returns [Country!]!
Example
Query
query countries {
countries {
code
id
name
}
}
Response
{
"data": {
"countries": [
{
"code": "xyz789",
"id": 4,
"name": "xyz789"
}
]
}
}
currentGroup
Description
The group selected via the X-Group-Id header, or the user's primary group.
Response
Returns a Group
Example
Query
query currentGroup {
currentGroup {
aboutButtonColor
aboutSubtitle
aboutText
aboutTitle
accentColor
account {
...AccountFragment
}
allowGroupSessions
allowMasterclasses
allowedSessionTypes
analyticsRestricted
archived
authProvider
autoAcceptBookingRequests
availabilityCounts {
...DateCountFragment
}
availabilitySchedule {
...AvailabilityDateFragment
}
backgroundColor
backgroundImage {
...GroupFileFragment
}
backgroundImages {
...GroupFileFragment
}
backgroundOpacity
backgroundOverlayColor
backgroundTextColor
calendarEnabled
cohorts {
...CohortFragment
}
conferenceType
consentText
customDomain
defaultLanguage
defaultProfileImage {
...GroupFileFragment
}
defaultProfileImageUrl
disciplines {
...DisciplineFragment
}
emailFooterImage {
...GroupFileFragment
}
emailHeaderImage {
...GroupFileFragment
}
endsAt
fileCategories {
...GroupFileCategoryFragment
}
files {
...GroupFileFragment
}
fontLink
fontName
goalsEnabled
groupUrl
hasIndependentSubdisciplines
hideMentors
highlightColor
id
independentSubdisciplines {
...SubdisciplineFragment
}
info
infoSize
key
languages {
...LanguageFragment
}
legacy
locations {
...LocationFragment
}
loginUrl
logoHeader
logoImage {
...GroupFileFragment
}
managers {
...UserFragment
}
marketplace
meetingProvider
member {
...UserFragment
}
memberCount
members {
...UserFragment
}
membersForSession {
...UserFragment
}
membersForSessionCount
menteeCapacity
menteeMaxSessions
mentorCapacity
mentorCount
mentorDisciplines {
...DisciplineFragment
}
mentorMaxSessions
mentorMenteeMaxSessions
mentors {
...UserFragment
}
monthlyBookingParticipationStats {
...MonthlyBookingParticipationFragment
}
name
onboardingConfig {
...OnboardingConfigFragment
}
otherMembers {
...UserFragment
}
otherMembersCount
pageLogoImage {
...GroupFileFragment
}
partnerHeader
partnerInfo
partnerLogoImage {
...GroupFileFragment
}
partnerLogoImages {
...GroupFileFragment
}
paymentSettings {
...GroupPaymentSettingsFragment
}
plan {
...PlanFragment
}
requiresPayment
segmentsEnabled
sessionLengths
skipOnboarding
slug
startsAt
styles {
...GroupStylesFragment
}
subtitle
subtitleSize
supporterLogoImages {
...GroupFileFragment
}
surveyQuestions {
...SurveyQuestionFragment
}
tag
tags {
...TagFragment
}
terminology
textColor
timeSlots {
...TimeSlotFragment
}
title
titleFontLink
titleFontName
titleImage {
...GroupFileFragment
}
titleSize
translationStatus {
...TranslationStatusFragment
}
url
useNylas
whiteLabel
}
}
Response
{
"data": {
"currentGroup": {
"aboutButtonColor": "xyz789",
"aboutSubtitle": "xyz789",
"aboutText": "xyz789",
"aboutTitle": "xyz789",
"accentColor": "xyz789",
"account": Account,
"allowGroupSessions": true,
"allowMasterclasses": false,
"allowedSessionTypes": ["groupSession"],
"analyticsRestricted": true,
"archived": false,
"authProvider": "facebook",
"autoAcceptBookingRequests": true,
"availabilityCounts": [DateCount],
"availabilitySchedule": [AvailabilityDate],
"backgroundColor": "abc123",
"backgroundImage": GroupFile,
"backgroundImages": [GroupFile],
"backgroundOpacity": 987.65,
"backgroundOverlayColor": "xyz789",
"backgroundTextColor": "xyz789",
"calendarEnabled": false,
"cohorts": [Cohort],
"conferenceType": "abc123",
"consentText": "abc123",
"customDomain": "xyz789",
"defaultLanguage": "abc123",
"defaultProfileImage": GroupFile,
"defaultProfileImageUrl": "abc123",
"disciplines": [Discipline],
"emailFooterImage": GroupFile,
"emailHeaderImage": GroupFile,
"endsAt": ISO8601DateTime,
"fileCategories": [GroupFileCategory],
"files": [GroupFile],
"fontLink": "abc123",
"fontName": "abc123",
"goalsEnabled": true,
"groupUrl": "xyz789",
"hasIndependentSubdisciplines": false,
"hideMentors": true,
"highlightColor": "abc123",
"id": "4",
"independentSubdisciplines": [Subdiscipline],
"info": "abc123",
"infoSize": 123,
"key": "4",
"languages": [Language],
"legacy": false,
"locations": [Location],
"loginUrl": "abc123",
"logoHeader": "xyz789",
"logoImage": GroupFile,
"managers": [User],
"marketplace": false,
"meetingProvider": "abc123",
"member": User,
"memberCount": 987,
"members": [User],
"membersForSession": [User],
"membersForSessionCount": 123,
"menteeCapacity": 123,
"menteeMaxSessions": 123,
"mentorCapacity": 987,
"mentorCount": 987,
"mentorDisciplines": [Discipline],
"mentorMaxSessions": 123,
"mentorMenteeMaxSessions": 987,
"mentors": [User],
"monthlyBookingParticipationStats": [
MonthlyBookingParticipation
],
"name": "abc123",
"onboardingConfig": OnboardingConfig,
"otherMembers": [User],
"otherMembersCount": 987,
"pageLogoImage": GroupFile,
"partnerHeader": "xyz789",
"partnerInfo": "abc123",
"partnerLogoImage": GroupFile,
"partnerLogoImages": [GroupFile],
"paymentSettings": GroupPaymentSettings,
"plan": Plan,
"requiresPayment": true,
"segmentsEnabled": true,
"sessionLengths": [987],
"skipOnboarding": true,
"slug": "abc123",
"startsAt": ISO8601DateTime,
"styles": GroupStyles,
"subtitle": "xyz789",
"subtitleSize": "abc123",
"supporterLogoImages": [GroupFile],
"surveyQuestions": [SurveyQuestion],
"tag": "xyz789",
"tags": [Tag],
"terminology": "abc123",
"textColor": "abc123",
"timeSlots": [TimeSlot],
"title": "abc123",
"titleFontLink": "abc123",
"titleFontName": "abc123",
"titleImage": GroupFile,
"titleSize": "abc123",
"translationStatus": [TranslationStatus],
"url": "abc123",
"useNylas": true,
"whiteLabel": true
}
}
}
disciplines
Description
Disciplines
Response
Returns [Discipline!]
Example
Query
query disciplines(
$groupId: ID,
$locale: String
) {
disciplines(
groupId: $groupId,
locale: $locale
) {
id
imageUrl
name
slug
subdisciplines {
...SubdisciplineFragment
}
userCount
}
}
Variables
{"groupId": 4, "locale": "abc123"}
Response
{
"data": {
"disciplines": [
{
"id": "4",
"imageUrl": "abc123",
"name": "xyz789",
"slug": "abc123",
"subdisciplines": [Subdiscipline],
"userCount": 987
}
]
}
}
emergingThemesAnalysis
Description
Analysis of emerging themes for a group
Response
Returns an EmergingThemesAnalysis!
Example
Query
query emergingThemesAnalysis(
$groupId: ID!,
$locale: String
) {
emergingThemesAnalysis(
groupId: $groupId,
locale: $locale
) {
metadata {
...AnalysisMetadataFragment
}
summary
themes {
...ThemeFragment
}
}
}
Variables
{"groupId": "4", "locale": "en"}
Response
{
"data": {
"emergingThemesAnalysis": {
"metadata": AnalysisMetadata,
"summary": "abc123",
"themes": [Theme]
}
}
}
faqCategories
Description
Marketing FAQ category index.
Response
Returns a FaqCategories!
Example
Query
query faqCategories {
faqCategories {
general {
...FaqContentFragment
}
payment {
...FaqContentFragment
}
pricing {
...FaqContentFragment
}
security {
...FaqContentFragment
}
}
}
Response
{
"data": {
"faqCategories": {
"general": [FaqContent],
"payment": [FaqContent],
"pricing": [FaqContent],
"security": [FaqContent]
}
}
}
faqContents
Description
Marketing FAQ entries, filterable by category or search.
Response
Returns [FaqContent!]!
Example
Query
query faqContents(
$locale: String,
$search: String
) {
faqContents(
locale: $locale,
search: $search
) {
answer
id
key
question
searchHighlight
}
}
Variables
{
"locale": "abc123",
"search": "xyz789"
}
Response
{
"data": {
"faqContents": [
{
"answer": "abc123",
"id": 4,
"key": 4,
"question": "abc123",
"searchHighlight": "xyz789"
}
]
}
}
featureContents
Description
Marketing feature blocks for the public website.
Response
Returns [FeatureContent!]!
Example
Query
query featureContents {
featureContents {
id
key
name
plan0
plan1
plan2
planEnterprise
planPro
planStart
planTeams
}
}
Response
{
"data": {
"featureContents": [
{
"id": "4",
"key": "4",
"name": "xyz789",
"plan0": "xyz789",
"plan1": "abc123",
"plan2": "abc123",
"planEnterprise": "xyz789",
"planPro": "xyz789",
"planStart": "abc123",
"planTeams": "xyz789"
}
]
}
}
group
Description
A single group (mentoring program) by id or slug.
Example
Query
query group(
$id: ID,
$slug: ID
) {
group(
id: $id,
slug: $slug
) {
aboutButtonColor
aboutSubtitle
aboutText
aboutTitle
accentColor
account {
...AccountFragment
}
allowGroupSessions
allowMasterclasses
allowedSessionTypes
analyticsRestricted
archived
authProvider
autoAcceptBookingRequests
availabilityCounts {
...DateCountFragment
}
availabilitySchedule {
...AvailabilityDateFragment
}
backgroundColor
backgroundImage {
...GroupFileFragment
}
backgroundImages {
...GroupFileFragment
}
backgroundOpacity
backgroundOverlayColor
backgroundTextColor
calendarEnabled
cohorts {
...CohortFragment
}
conferenceType
consentText
customDomain
defaultLanguage
defaultProfileImage {
...GroupFileFragment
}
defaultProfileImageUrl
disciplines {
...DisciplineFragment
}
emailFooterImage {
...GroupFileFragment
}
emailHeaderImage {
...GroupFileFragment
}
endsAt
fileCategories {
...GroupFileCategoryFragment
}
files {
...GroupFileFragment
}
fontLink
fontName
goalsEnabled
groupUrl
hasIndependentSubdisciplines
hideMentors
highlightColor
id
independentSubdisciplines {
...SubdisciplineFragment
}
info
infoSize
key
languages {
...LanguageFragment
}
legacy
locations {
...LocationFragment
}
loginUrl
logoHeader
logoImage {
...GroupFileFragment
}
managers {
...UserFragment
}
marketplace
meetingProvider
member {
...UserFragment
}
memberCount
members {
...UserFragment
}
membersForSession {
...UserFragment
}
membersForSessionCount
menteeCapacity
menteeMaxSessions
mentorCapacity
mentorCount
mentorDisciplines {
...DisciplineFragment
}
mentorMaxSessions
mentorMenteeMaxSessions
mentors {
...UserFragment
}
monthlyBookingParticipationStats {
...MonthlyBookingParticipationFragment
}
name
onboardingConfig {
...OnboardingConfigFragment
}
otherMembers {
...UserFragment
}
otherMembersCount
pageLogoImage {
...GroupFileFragment
}
partnerHeader
partnerInfo
partnerLogoImage {
...GroupFileFragment
}
partnerLogoImages {
...GroupFileFragment
}
paymentSettings {
...GroupPaymentSettingsFragment
}
plan {
...PlanFragment
}
requiresPayment
segmentsEnabled
sessionLengths
skipOnboarding
slug
startsAt
styles {
...GroupStylesFragment
}
subtitle
subtitleSize
supporterLogoImages {
...GroupFileFragment
}
surveyQuestions {
...SurveyQuestionFragment
}
tag
tags {
...TagFragment
}
terminology
textColor
timeSlots {
...TimeSlotFragment
}
title
titleFontLink
titleFontName
titleImage {
...GroupFileFragment
}
titleSize
translationStatus {
...TranslationStatusFragment
}
url
useNylas
whiteLabel
}
}
Variables
{
"id": "4",
"slug": "4"
}
Response
{
"data": {
"group": {
"aboutButtonColor": "abc123",
"aboutSubtitle": "abc123",
"aboutText": "abc123",
"aboutTitle": "xyz789",
"accentColor": "xyz789",
"account": Account,
"allowGroupSessions": false,
"allowMasterclasses": true,
"allowedSessionTypes": ["groupSession"],
"analyticsRestricted": true,
"archived": false,
"authProvider": "facebook",
"autoAcceptBookingRequests": true,
"availabilityCounts": [DateCount],
"availabilitySchedule": [AvailabilityDate],
"backgroundColor": "abc123",
"backgroundImage": GroupFile,
"backgroundImages": [GroupFile],
"backgroundOpacity": 987.65,
"backgroundOverlayColor": "abc123",
"backgroundTextColor": "xyz789",
"calendarEnabled": false,
"cohorts": [Cohort],
"conferenceType": "xyz789",
"consentText": "xyz789",
"customDomain": "abc123",
"defaultLanguage": "xyz789",
"defaultProfileImage": GroupFile,
"defaultProfileImageUrl": "abc123",
"disciplines": [Discipline],
"emailFooterImage": GroupFile,
"emailHeaderImage": GroupFile,
"endsAt": ISO8601DateTime,
"fileCategories": [GroupFileCategory],
"files": [GroupFile],
"fontLink": "abc123",
"fontName": "xyz789",
"goalsEnabled": true,
"groupUrl": "xyz789",
"hasIndependentSubdisciplines": false,
"hideMentors": false,
"highlightColor": "xyz789",
"id": 4,
"independentSubdisciplines": [Subdiscipline],
"info": "xyz789",
"infoSize": 987,
"key": 4,
"languages": [Language],
"legacy": true,
"locations": [Location],
"loginUrl": "xyz789",
"logoHeader": "abc123",
"logoImage": GroupFile,
"managers": [User],
"marketplace": false,
"meetingProvider": "xyz789",
"member": User,
"memberCount": 123,
"members": [User],
"membersForSession": [User],
"membersForSessionCount": 123,
"menteeCapacity": 123,
"menteeMaxSessions": 987,
"mentorCapacity": 987,
"mentorCount": 987,
"mentorDisciplines": [Discipline],
"mentorMaxSessions": 987,
"mentorMenteeMaxSessions": 123,
"mentors": [User],
"monthlyBookingParticipationStats": [
MonthlyBookingParticipation
],
"name": "xyz789",
"onboardingConfig": OnboardingConfig,
"otherMembers": [User],
"otherMembersCount": 123,
"pageLogoImage": GroupFile,
"partnerHeader": "abc123",
"partnerInfo": "abc123",
"partnerLogoImage": GroupFile,
"partnerLogoImages": [GroupFile],
"paymentSettings": GroupPaymentSettings,
"plan": Plan,
"requiresPayment": true,
"segmentsEnabled": true,
"sessionLengths": [123],
"skipOnboarding": true,
"slug": "abc123",
"startsAt": ISO8601DateTime,
"styles": GroupStyles,
"subtitle": "xyz789",
"subtitleSize": "xyz789",
"supporterLogoImages": [GroupFile],
"surveyQuestions": [SurveyQuestion],
"tag": "abc123",
"tags": [Tag],
"terminology": "abc123",
"textColor": "abc123",
"timeSlots": [TimeSlot],
"title": "abc123",
"titleFontLink": "abc123",
"titleFontName": "xyz789",
"titleImage": GroupFile,
"titleSize": "abc123",
"translationStatus": [TranslationStatus],
"url": "xyz789",
"useNylas": false,
"whiteLabel": true
}
}
}
groups
Description
All groups visible to the caller; tenant-scoped by membership.
Response
Returns [Group!]!
Example
Query
query groups {
groups {
aboutButtonColor
aboutSubtitle
aboutText
aboutTitle
accentColor
account {
...AccountFragment
}
allowGroupSessions
allowMasterclasses
allowedSessionTypes
analyticsRestricted
archived
authProvider
autoAcceptBookingRequests
availabilityCounts {
...DateCountFragment
}
availabilitySchedule {
...AvailabilityDateFragment
}
backgroundColor
backgroundImage {
...GroupFileFragment
}
backgroundImages {
...GroupFileFragment
}
backgroundOpacity
backgroundOverlayColor
backgroundTextColor
calendarEnabled
cohorts {
...CohortFragment
}
conferenceType
consentText
customDomain
defaultLanguage
defaultProfileImage {
...GroupFileFragment
}
defaultProfileImageUrl
disciplines {
...DisciplineFragment
}
emailFooterImage {
...GroupFileFragment
}
emailHeaderImage {
...GroupFileFragment
}
endsAt
fileCategories {
...GroupFileCategoryFragment
}
files {
...GroupFileFragment
}
fontLink
fontName
goalsEnabled
groupUrl
hasIndependentSubdisciplines
hideMentors
highlightColor
id
independentSubdisciplines {
...SubdisciplineFragment
}
info
infoSize
key
languages {
...LanguageFragment
}
legacy
locations {
...LocationFragment
}
loginUrl
logoHeader
logoImage {
...GroupFileFragment
}
managers {
...UserFragment
}
marketplace
meetingProvider
member {
...UserFragment
}
memberCount
members {
...UserFragment
}
membersForSession {
...UserFragment
}
membersForSessionCount
menteeCapacity
menteeMaxSessions
mentorCapacity
mentorCount
mentorDisciplines {
...DisciplineFragment
}
mentorMaxSessions
mentorMenteeMaxSessions
mentors {
...UserFragment
}
monthlyBookingParticipationStats {
...MonthlyBookingParticipationFragment
}
name
onboardingConfig {
...OnboardingConfigFragment
}
otherMembers {
...UserFragment
}
otherMembersCount
pageLogoImage {
...GroupFileFragment
}
partnerHeader
partnerInfo
partnerLogoImage {
...GroupFileFragment
}
partnerLogoImages {
...GroupFileFragment
}
paymentSettings {
...GroupPaymentSettingsFragment
}
plan {
...PlanFragment
}
requiresPayment
segmentsEnabled
sessionLengths
skipOnboarding
slug
startsAt
styles {
...GroupStylesFragment
}
subtitle
subtitleSize
supporterLogoImages {
...GroupFileFragment
}
surveyQuestions {
...SurveyQuestionFragment
}
tag
tags {
...TagFragment
}
terminology
textColor
timeSlots {
...TimeSlotFragment
}
title
titleFontLink
titleFontName
titleImage {
...GroupFileFragment
}
titleSize
translationStatus {
...TranslationStatusFragment
}
url
useNylas
whiteLabel
}
}
Response
{
"data": {
"groups": [
{
"aboutButtonColor": "abc123",
"aboutSubtitle": "xyz789",
"aboutText": "xyz789",
"aboutTitle": "abc123",
"accentColor": "xyz789",
"account": Account,
"allowGroupSessions": false,
"allowMasterclasses": true,
"allowedSessionTypes": ["groupSession"],
"analyticsRestricted": true,
"archived": false,
"authProvider": "facebook",
"autoAcceptBookingRequests": false,
"availabilityCounts": [DateCount],
"availabilitySchedule": [AvailabilityDate],
"backgroundColor": "xyz789",
"backgroundImage": GroupFile,
"backgroundImages": [GroupFile],
"backgroundOpacity": 987.65,
"backgroundOverlayColor": "abc123",
"backgroundTextColor": "xyz789",
"calendarEnabled": true,
"cohorts": [Cohort],
"conferenceType": "xyz789",
"consentText": "abc123",
"customDomain": "xyz789",
"defaultLanguage": "abc123",
"defaultProfileImage": GroupFile,
"defaultProfileImageUrl": "xyz789",
"disciplines": [Discipline],
"emailFooterImage": GroupFile,
"emailHeaderImage": GroupFile,
"endsAt": ISO8601DateTime,
"fileCategories": [GroupFileCategory],
"files": [GroupFile],
"fontLink": "xyz789",
"fontName": "xyz789",
"goalsEnabled": false,
"groupUrl": "abc123",
"hasIndependentSubdisciplines": true,
"hideMentors": false,
"highlightColor": "xyz789",
"id": "4",
"independentSubdisciplines": [Subdiscipline],
"info": "abc123",
"infoSize": 987,
"key": "4",
"languages": [Language],
"legacy": false,
"locations": [Location],
"loginUrl": "xyz789",
"logoHeader": "abc123",
"logoImage": GroupFile,
"managers": [User],
"marketplace": false,
"meetingProvider": "xyz789",
"member": User,
"memberCount": 987,
"members": [User],
"membersForSession": [User],
"membersForSessionCount": 987,
"menteeCapacity": 987,
"menteeMaxSessions": 123,
"mentorCapacity": 987,
"mentorCount": 123,
"mentorDisciplines": [Discipline],
"mentorMaxSessions": 123,
"mentorMenteeMaxSessions": 987,
"mentors": [User],
"monthlyBookingParticipationStats": [
MonthlyBookingParticipation
],
"name": "xyz789",
"onboardingConfig": OnboardingConfig,
"otherMembers": [User],
"otherMembersCount": 123,
"pageLogoImage": GroupFile,
"partnerHeader": "abc123",
"partnerInfo": "abc123",
"partnerLogoImage": GroupFile,
"partnerLogoImages": [GroupFile],
"paymentSettings": GroupPaymentSettings,
"plan": Plan,
"requiresPayment": false,
"segmentsEnabled": false,
"sessionLengths": [987],
"skipOnboarding": true,
"slug": "abc123",
"startsAt": ISO8601DateTime,
"styles": GroupStyles,
"subtitle": "xyz789",
"subtitleSize": "abc123",
"supporterLogoImages": [GroupFile],
"surveyQuestions": [SurveyQuestion],
"tag": "xyz789",
"tags": [Tag],
"terminology": "abc123",
"textColor": "xyz789",
"timeSlots": [TimeSlot],
"title": "abc123",
"titleFontLink": "xyz789",
"titleFontName": "xyz789",
"titleImage": GroupFile,
"titleSize": "abc123",
"translationStatus": [TranslationStatus],
"url": "abc123",
"useNylas": true,
"whiteLabel": false
}
]
}
}
helpCollections
Description
Marketing help-center collections for the public website.
Response
Returns [HelpCollection!]!
Example
Query
query helpCollections {
helpCollections {
description
iconUrl
id
name
sections {
...HelpSectionFragment
}
url
}
}
Response
{
"data": {
"helpCollections": [
{
"description": "abc123",
"iconUrl": "abc123",
"id": "4",
"name": "xyz789",
"sections": [HelpSection],
"url": "xyz789"
}
]
}
}
jobContents
Description
Marketing job/role content for the public website.
Response
Returns [JobContent!]!
Example
Query
query jobContents {
jobContents {
applicationUrl
businessFunction
description
id
jobTitle
key
location
seniority
}
}
Response
{
"data": {
"jobContents": [
{
"applicationUrl": "xyz789",
"businessFunction": "abc123",
"description": "xyz789",
"id": "4",
"jobTitle": "abc123",
"key": "4",
"location": "abc123",
"seniority": "abc123"
}
]
}
}
knowledgeGapAnalysis
Description
Analysis of knowledge gaps for a group
Response
Returns a KnowledgeGapAnalysis!
Example
Query
query knowledgeGapAnalysis(
$groupId: ID!,
$locale: String
) {
knowledgeGapAnalysis(
groupId: $groupId,
locale: $locale
) {
gaps {
...KnowledgeGapFragment
}
metadata {
...AnalysisMetadataFragment
}
rawData {
...KnowledgeGapRawDataFragment
}
summary
}
}
Variables
{"groupId": "4", "locale": "en"}
Response
{
"data": {
"knowledgeGapAnalysis": {
"gaps": [KnowledgeGap],
"metadata": AnalysisMetadata,
"rawData": KnowledgeGapRawData,
"summary": "abc123"
}
}
}
languages
Description
Languages
Response
Returns [Language!]!
Arguments
| Name | Description |
|---|---|
groupId - ID
|
Example
Query
query languages($groupId: ID) {
languages(groupId: $groupId) {
code
id
name
}
}
Variables
{"groupId": "4"}
Response
{
"data": {
"languages": [
{
"code": "xyz789",
"id": "4",
"name": "xyz789"
}
]
}
}
managedGroup
Description
A single group from the program-manager perspective (admin-extended fields).
Response
Returns a ManagedGroup
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query managedGroup($id: ID!) {
managedGroup(id: $id) {
aboutButtonColor
aboutSubtitle
aboutText
aboutTitle
accentColor
account {
...AccountFragment
}
allowGroupSessions
allowMasterclasses
allowedSessionTypes
analyticsRestricted
archived
authProvider
autoAcceptBookingRequests
availabilityCounts {
...DateCountFragment
}
availabilitySchedule {
...AvailabilityDateFragment
}
averageSessionRating
backgroundColor
backgroundImage {
...GroupFileFragment
}
backgroundImages {
...GroupFileFragment
}
backgroundOpacity
backgroundOverlayColor
backgroundTextColor
billingType
bookingCount
bookings {
...BookingFragment
}
calendarEnabled
cohorts {
...CohortFragment
}
combinedStats
conferenceType
consentText
customDomain
dashboard {
...GroupDashboardFragment
}
defaultLanguage
defaultProfileImage {
...GroupFileFragment
}
defaultProfileImageUrl
disciplines {
...DisciplineFragment
}
emailContent {
...EmailContentFragment
}
emailContents {
...EmailContentFragment
}
emailFooterImage {
...GroupFileFragment
}
emailHeaderImage {
...GroupFileFragment
}
enableCohorts
endsAt
fieldStats
fileCategories {
...GroupFileCategoryFragment
}
files {
...GroupFileFragment
}
filteredPoolCount
filteredPoolMembers {
...ManagedUserFragment
}
fontLink
fontName
globalStats
goalsEnabled
groupUrl
groupedBookingStats
groupedMemberStats
hasIndependentSubdisciplines
hideMentors
highlightColor
id
independentSubdisciplines {
...SubdisciplineFragment
}
info
infoSize
jobStatus {
...JobStatusFragment
}
jobStatuses {
...JobStatusFragment
}
key
languages {
...LanguageFragment
}
legacy
locations {
...LocationFragment
}
loginUrl
logoHeader
logoImage {
...GroupFileFragment
}
managers {
...UserFragment
}
marketplace
matchCount
matchCounts {
...MatchCountsFragment
}
matches {
...MentorMatchFragment
}
matchingRun {
...MatchingRunFragment
}
matchingRuns {
...MatchingRunFragment
}
meetingProvider
member {
...ManagedUserFragment
}
memberCount
memberStats {
...ReportsUserFragment
}
memberStatusStats
members {
...ManagedUserFragment
}
membersForSession {
...UserFragment
}
membersForSessionCount
menteeCapacity
menteeMaxSessions
menteeSessionCountStats
mentorCapacity
mentorCount
mentorCountStats
mentorDisciplines {
...DisciplineFragment
}
mentorMaxSessions
mentorMenteeMaxSessions
mentors {
...UserFragment
}
monthRange
monthlyBookingParticipationStats {
...MonthlyBookingParticipationFragment
}
monthlyStats
name
onboardingConfig {
...OnboardingConfigFragment
}
otherMembers {
...UserFragment
}
otherMembersCount
pageLogoImage {
...GroupFileFragment
}
partnerHeader
partnerInfo
partnerLogoImage {
...GroupFileFragment
}
partnerLogoImages {
...GroupFileFragment
}
paymentSettings {
...GroupPaymentSettingsFragment
}
plan {
...PlanFragment
}
requiresPayment
reviewCount
reviews {
...ReviewFragment
}
segmentsEnabled
sessionCount
sessionCounts {
...DateCountFragment
}
sessionLengths
sessions {
...BookingFragment
}
signupStats
skipOnboarding
slug
startsAt
styles {
...GroupStylesFragment
}
subtitle
subtitleSize
supporterLogoImages {
...GroupFileFragment
}
surveyQuestions {
...SurveyQuestionFragment
}
tag
tags {
...TagFragment
}
terminology
textColor
timeSlots {
...TimeSlotFragment
}
title
titleFontLink
titleFontName
titleImage {
...GroupFileFragment
}
titleSize
translationStatus {
...TranslationStatusFragment
}
url
useNylas
whiteLabel
}
}
Variables
{"id": 4}
Response
{
"data": {
"managedGroup": {
"aboutButtonColor": "abc123",
"aboutSubtitle": "abc123",
"aboutText": "abc123",
"aboutTitle": "abc123",
"accentColor": "abc123",
"account": Account,
"allowGroupSessions": false,
"allowMasterclasses": false,
"allowedSessionTypes": ["groupSession"],
"analyticsRestricted": true,
"archived": true,
"authProvider": "facebook",
"autoAcceptBookingRequests": true,
"availabilityCounts": [DateCount],
"availabilitySchedule": [AvailabilityDate],
"averageSessionRating": 123.45,
"backgroundColor": "abc123",
"backgroundImage": GroupFile,
"backgroundImages": [GroupFile],
"backgroundOpacity": 123.45,
"backgroundOverlayColor": "xyz789",
"backgroundTextColor": "abc123",
"billingType": "xyz789",
"bookingCount": 123,
"bookings": [Booking],
"calendarEnabled": false,
"cohorts": [Cohort],
"combinedStats": {},
"conferenceType": "xyz789",
"consentText": "abc123",
"customDomain": "xyz789",
"dashboard": GroupDashboard,
"defaultLanguage": "abc123",
"defaultProfileImage": GroupFile,
"defaultProfileImageUrl": "xyz789",
"disciplines": [Discipline],
"emailContent": EmailContent,
"emailContents": [EmailContent],
"emailFooterImage": GroupFile,
"emailHeaderImage": GroupFile,
"enableCohorts": true,
"endsAt": ISO8601DateTime,
"fieldStats": {},
"fileCategories": [GroupFileCategory],
"files": [GroupFile],
"filteredPoolCount": 123,
"filteredPoolMembers": [ManagedUser],
"fontLink": "xyz789",
"fontName": "abc123",
"globalStats": {},
"goalsEnabled": false,
"groupUrl": "abc123",
"groupedBookingStats": {},
"groupedMemberStats": {},
"hasIndependentSubdisciplines": true,
"hideMentors": true,
"highlightColor": "xyz789",
"id": "4",
"independentSubdisciplines": [Subdiscipline],
"info": "xyz789",
"infoSize": 987,
"jobStatus": JobStatus,
"jobStatuses": [JobStatus],
"key": 4,
"languages": [Language],
"legacy": true,
"locations": [Location],
"loginUrl": "xyz789",
"logoHeader": "abc123",
"logoImage": GroupFile,
"managers": [User],
"marketplace": false,
"matchCount": 987,
"matchCounts": MatchCounts,
"matches": [MentorMatch],
"matchingRun": MatchingRun,
"matchingRuns": [MatchingRun],
"meetingProvider": "abc123",
"member": ManagedUser,
"memberCount": 987,
"memberStats": [ReportsUser],
"memberStatusStats": {},
"members": [ManagedUser],
"membersForSession": [User],
"membersForSessionCount": 987,
"menteeCapacity": 987,
"menteeMaxSessions": 987,
"menteeSessionCountStats": {},
"mentorCapacity": 123,
"mentorCount": 987,
"mentorCountStats": {},
"mentorDisciplines": [Discipline],
"mentorMaxSessions": 123,
"mentorMenteeMaxSessions": 987,
"mentors": [User],
"monthRange": {},
"monthlyBookingParticipationStats": [
MonthlyBookingParticipation
],
"monthlyStats": {},
"name": "xyz789",
"onboardingConfig": OnboardingConfig,
"otherMembers": [User],
"otherMembersCount": 123,
"pageLogoImage": GroupFile,
"partnerHeader": "abc123",
"partnerInfo": "abc123",
"partnerLogoImage": GroupFile,
"partnerLogoImages": [GroupFile],
"paymentSettings": GroupPaymentSettings,
"plan": Plan,
"requiresPayment": false,
"reviewCount": 123,
"reviews": [Review],
"segmentsEnabled": true,
"sessionCount": 123,
"sessionCounts": [DateCount],
"sessionLengths": [987],
"sessions": [Booking],
"signupStats": {},
"skipOnboarding": true,
"slug": "abc123",
"startsAt": ISO8601DateTime,
"styles": GroupStyles,
"subtitle": "abc123",
"subtitleSize": "xyz789",
"supporterLogoImages": [GroupFile],
"surveyQuestions": [SurveyQuestion],
"tag": "xyz789",
"tags": [Tag],
"terminology": "abc123",
"textColor": "abc123",
"timeSlots": [TimeSlot],
"title": "xyz789",
"titleFontLink": "xyz789",
"titleFontName": "abc123",
"titleImage": GroupFile,
"titleSize": "abc123",
"translationStatus": [TranslationStatus],
"url": "abc123",
"useNylas": true,
"whiteLabel": true
}
}
}
managedGroups
Description
Groups the caller can manage (program manager or mentorly admin).
Response
Returns [ManagedGroup!]!
Example
Query
query managedGroups {
managedGroups {
aboutButtonColor
aboutSubtitle
aboutText
aboutTitle
accentColor
account {
...AccountFragment
}
allowGroupSessions
allowMasterclasses
allowedSessionTypes
analyticsRestricted
archived
authProvider
autoAcceptBookingRequests
availabilityCounts {
...DateCountFragment
}
availabilitySchedule {
...AvailabilityDateFragment
}
averageSessionRating
backgroundColor
backgroundImage {
...GroupFileFragment
}
backgroundImages {
...GroupFileFragment
}
backgroundOpacity
backgroundOverlayColor
backgroundTextColor
billingType
bookingCount
bookings {
...BookingFragment
}
calendarEnabled
cohorts {
...CohortFragment
}
combinedStats
conferenceType
consentText
customDomain
dashboard {
...GroupDashboardFragment
}
defaultLanguage
defaultProfileImage {
...GroupFileFragment
}
defaultProfileImageUrl
disciplines {
...DisciplineFragment
}
emailContent {
...EmailContentFragment
}
emailContents {
...EmailContentFragment
}
emailFooterImage {
...GroupFileFragment
}
emailHeaderImage {
...GroupFileFragment
}
enableCohorts
endsAt
fieldStats
fileCategories {
...GroupFileCategoryFragment
}
files {
...GroupFileFragment
}
filteredPoolCount
filteredPoolMembers {
...ManagedUserFragment
}
fontLink
fontName
globalStats
goalsEnabled
groupUrl
groupedBookingStats
groupedMemberStats
hasIndependentSubdisciplines
hideMentors
highlightColor
id
independentSubdisciplines {
...SubdisciplineFragment
}
info
infoSize
jobStatus {
...JobStatusFragment
}
jobStatuses {
...JobStatusFragment
}
key
languages {
...LanguageFragment
}
legacy
locations {
...LocationFragment
}
loginUrl
logoHeader
logoImage {
...GroupFileFragment
}
managers {
...UserFragment
}
marketplace
matchCount
matchCounts {
...MatchCountsFragment
}
matches {
...MentorMatchFragment
}
matchingRun {
...MatchingRunFragment
}
matchingRuns {
...MatchingRunFragment
}
meetingProvider
member {
...ManagedUserFragment
}
memberCount
memberStats {
...ReportsUserFragment
}
memberStatusStats
members {
...ManagedUserFragment
}
membersForSession {
...UserFragment
}
membersForSessionCount
menteeCapacity
menteeMaxSessions
menteeSessionCountStats
mentorCapacity
mentorCount
mentorCountStats
mentorDisciplines {
...DisciplineFragment
}
mentorMaxSessions
mentorMenteeMaxSessions
mentors {
...UserFragment
}
monthRange
monthlyBookingParticipationStats {
...MonthlyBookingParticipationFragment
}
monthlyStats
name
onboardingConfig {
...OnboardingConfigFragment
}
otherMembers {
...UserFragment
}
otherMembersCount
pageLogoImage {
...GroupFileFragment
}
partnerHeader
partnerInfo
partnerLogoImage {
...GroupFileFragment
}
partnerLogoImages {
...GroupFileFragment
}
paymentSettings {
...GroupPaymentSettingsFragment
}
plan {
...PlanFragment
}
requiresPayment
reviewCount
reviews {
...ReviewFragment
}
segmentsEnabled
sessionCount
sessionCounts {
...DateCountFragment
}
sessionLengths
sessions {
...BookingFragment
}
signupStats
skipOnboarding
slug
startsAt
styles {
...GroupStylesFragment
}
subtitle
subtitleSize
supporterLogoImages {
...GroupFileFragment
}
surveyQuestions {
...SurveyQuestionFragment
}
tag
tags {
...TagFragment
}
terminology
textColor
timeSlots {
...TimeSlotFragment
}
title
titleFontLink
titleFontName
titleImage {
...GroupFileFragment
}
titleSize
translationStatus {
...TranslationStatusFragment
}
url
useNylas
whiteLabel
}
}
Response
{
"data": {
"managedGroups": [
{
"aboutButtonColor": "xyz789",
"aboutSubtitle": "xyz789",
"aboutText": "abc123",
"aboutTitle": "xyz789",
"accentColor": "abc123",
"account": Account,
"allowGroupSessions": true,
"allowMasterclasses": false,
"allowedSessionTypes": ["groupSession"],
"analyticsRestricted": true,
"archived": false,
"authProvider": "facebook",
"autoAcceptBookingRequests": true,
"availabilityCounts": [DateCount],
"availabilitySchedule": [AvailabilityDate],
"averageSessionRating": 987.65,
"backgroundColor": "abc123",
"backgroundImage": GroupFile,
"backgroundImages": [GroupFile],
"backgroundOpacity": 123.45,
"backgroundOverlayColor": "xyz789",
"backgroundTextColor": "abc123",
"billingType": "abc123",
"bookingCount": 987,
"bookings": [Booking],
"calendarEnabled": false,
"cohorts": [Cohort],
"combinedStats": {},
"conferenceType": "abc123",
"consentText": "abc123",
"customDomain": "abc123",
"dashboard": GroupDashboard,
"defaultLanguage": "abc123",
"defaultProfileImage": GroupFile,
"defaultProfileImageUrl": "abc123",
"disciplines": [Discipline],
"emailContent": EmailContent,
"emailContents": [EmailContent],
"emailFooterImage": GroupFile,
"emailHeaderImage": GroupFile,
"enableCohorts": false,
"endsAt": ISO8601DateTime,
"fieldStats": {},
"fileCategories": [GroupFileCategory],
"files": [GroupFile],
"filteredPoolCount": 987,
"filteredPoolMembers": [ManagedUser],
"fontLink": "abc123",
"fontName": "abc123",
"globalStats": {},
"goalsEnabled": true,
"groupUrl": "abc123",
"groupedBookingStats": {},
"groupedMemberStats": {},
"hasIndependentSubdisciplines": true,
"hideMentors": true,
"highlightColor": "abc123",
"id": 4,
"independentSubdisciplines": [Subdiscipline],
"info": "xyz789",
"infoSize": 123,
"jobStatus": JobStatus,
"jobStatuses": [JobStatus],
"key": 4,
"languages": [Language],
"legacy": false,
"locations": [Location],
"loginUrl": "xyz789",
"logoHeader": "xyz789",
"logoImage": GroupFile,
"managers": [User],
"marketplace": true,
"matchCount": 123,
"matchCounts": MatchCounts,
"matches": [MentorMatch],
"matchingRun": MatchingRun,
"matchingRuns": [MatchingRun],
"meetingProvider": "abc123",
"member": ManagedUser,
"memberCount": 123,
"memberStats": [ReportsUser],
"memberStatusStats": {},
"members": [ManagedUser],
"membersForSession": [User],
"membersForSessionCount": 123,
"menteeCapacity": 123,
"menteeMaxSessions": 123,
"menteeSessionCountStats": {},
"mentorCapacity": 987,
"mentorCount": 123,
"mentorCountStats": {},
"mentorDisciplines": [Discipline],
"mentorMaxSessions": 123,
"mentorMenteeMaxSessions": 123,
"mentors": [User],
"monthRange": {},
"monthlyBookingParticipationStats": [
MonthlyBookingParticipation
],
"monthlyStats": {},
"name": "abc123",
"onboardingConfig": OnboardingConfig,
"otherMembers": [User],
"otherMembersCount": 123,
"pageLogoImage": GroupFile,
"partnerHeader": "abc123",
"partnerInfo": "xyz789",
"partnerLogoImage": GroupFile,
"partnerLogoImages": [GroupFile],
"paymentSettings": GroupPaymentSettings,
"plan": Plan,
"requiresPayment": true,
"reviewCount": 123,
"reviews": [Review],
"segmentsEnabled": true,
"sessionCount": 123,
"sessionCounts": [DateCount],
"sessionLengths": [987],
"sessions": [Booking],
"signupStats": {},
"skipOnboarding": false,
"slug": "abc123",
"startsAt": ISO8601DateTime,
"styles": GroupStyles,
"subtitle": "abc123",
"subtitleSize": "xyz789",
"supporterLogoImages": [GroupFile],
"surveyQuestions": [SurveyQuestion],
"tag": "xyz789",
"tags": [Tag],
"terminology": "xyz789",
"textColor": "xyz789",
"timeSlots": [TimeSlot],
"title": "abc123",
"titleFontLink": "abc123",
"titleFontName": "abc123",
"titleImage": GroupFile,
"titleSize": "xyz789",
"translationStatus": [TranslationStatus],
"url": "abc123",
"useNylas": false,
"whiteLabel": true
}
]
}
}
menteeGoals
Description
Goals for mentees matched with current mentor
Response
Returns [UserGoal!]!
Example
Query
query menteeGoals(
$includeArchived: Boolean,
$menteeId: ID
) {
menteeGoals(
includeArchived: $includeArchived,
menteeId: $menteeId
) {
achievementReflection
completedAt
createdAt
deletedAt
goalText
id
isActive
isCompleted
isDeleted
progressNotes {
...GoalProgressNoteFragment
}
updatedAt
user {
...UserFragment
}
userId
}
}
Variables
{"includeArchived": false, "menteeId": "4"}
Response
{
"data": {
"menteeGoals": [
{
"achievementReflection": "xyz789",
"completedAt": ISO8601DateTime,
"createdAt": ISO8601DateTime,
"deletedAt": ISO8601DateTime,
"goalText": "abc123",
"id": 4,
"isActive": true,
"isCompleted": false,
"isDeleted": false,
"progressNotes": [GoalProgressNote],
"updatedAt": ISO8601DateTime,
"user": User,
"userId": 4
}
]
}
}
mentor
Description
A single mentor by id; visible to peers in the same group.
Example
Query
query mentor($id: ID!) {
mentor(id: $id) {
accounts {
...AccountFragment
}
activeGoals {
...UserGoalFragment
}
activeSubscription
allowGroupSessions
availabilities {
...AvailabilityFragment
}
availabilityCounts {
...DateCountFragment
}
avatar {
...AvatarFragment
}
behanceLink
bookable
bookingLink
bookings {
...BookingFragment
}
cancellationPolicy
cohort {
...CohortFragment
}
company
completedGoals {
...UserGoalFragment
}
country {
...CountryFragment
}
countryCode
createdUsing
description
discipline {
...DisciplineFragment
}
disciplineNames
disciplines {
...DisciplineFragment
}
dribbbleLink
effectiveMenteeCapacity
effectiveMentorCapacity
experience
facebookLink
files {
...UserFileFragment
}
firstName
goals {
...UserGoalFragment
}
group {
...GroupFragment
}
groupSessions {
...BookingFragment
}
hardSkills
hasAvailability
id
instagramLink
isActive
isMatched
languages {
...LanguageFragment
}
lastName
lastSignInAt
linkedinLink
location
longTermGoals
market
masterclasses {
...BookingFragment
}
matchingPercent
menteeCapacity
menteeMatchesRemaining
menteeSessionsRemaining
mentor
mentorCapacity
mentorMatchesRemaining
mentorSessionsRemaining
mentorlyAdmin
missingMatchingFields
missingProfileFields
name
newProfileImage {
...UploadedFileFragment
}
newProfileImageUrl
onboardingPercent
paymentRequired
peopleNetwork
preferredLanguage {
...LanguageFragment
}
profileImagePath
profileImageSettings {
...ImageSettingsFragment
}
profileImageUrl
profilePercent
pronouns
publicProfileSegments {
...PublicProfileSegmentFragment
}
publicTagList
rate30
rate60
rates
role
sessionLengths
sessionsRemaining
shortTermGoals
skills
slug
socialLinks {
...SocialLinkFragment
}
softSkills
status
subdisciplineNames
subdisciplines {
...SubdisciplineFragment
}
tags {
...TagFragment
}
tier
timeSlot {
...TimeSlotFragment
}
timeSlots {
...TimeSlotFragment
}
timezone
twitterLink
uid
userRole
vimeoLink
website
welcomeMessage
youtubeLink
}
}
Variables
{"id": "4"}
Response
{
"data": {
"mentor": {
"accounts": [Account],
"activeGoals": [UserGoal],
"activeSubscription": true,
"allowGroupSessions": false,
"availabilities": [Availability],
"availabilityCounts": [DateCount],
"avatar": Avatar,
"behanceLink": "xyz789",
"bookable": true,
"bookingLink": "xyz789",
"bookings": [Booking],
"cancellationPolicy": "xyz789",
"cohort": Cohort,
"company": "abc123",
"completedGoals": [UserGoal],
"country": Country,
"countryCode": "xyz789",
"createdUsing": "xyz789",
"description": "xyz789",
"discipline": Discipline,
"disciplineNames": ["xyz789"],
"disciplines": [Discipline],
"dribbbleLink": "xyz789",
"effectiveMenteeCapacity": 123,
"effectiveMentorCapacity": 123,
"experience": 987,
"facebookLink": "xyz789",
"files": [UserFile],
"firstName": "abc123",
"goals": [UserGoal],
"group": Group,
"groupSessions": [Booking],
"hardSkills": "abc123",
"hasAvailability": false,
"id": 4,
"instagramLink": "xyz789",
"isActive": false,
"isMatched": false,
"languages": [Language],
"lastName": "abc123",
"lastSignInAt": ISO8601DateTime,
"linkedinLink": "abc123",
"location": "xyz789",
"longTermGoals": "xyz789",
"market": "xyz789",
"masterclasses": [Booking],
"matchingPercent": 987,
"menteeCapacity": 987,
"menteeMatchesRemaining": 123,
"menteeSessionsRemaining": 123,
"mentor": false,
"mentorCapacity": 123,
"mentorMatchesRemaining": 123,
"mentorSessionsRemaining": 123,
"mentorlyAdmin": false,
"missingMatchingFields": ["xyz789"],
"missingProfileFields": ["abc123"],
"name": "abc123",
"newProfileImage": UploadedFile,
"newProfileImageUrl": "abc123",
"onboardingPercent": 123,
"paymentRequired": false,
"peopleNetwork": ["abc123"],
"preferredLanguage": Language,
"profileImagePath": "xyz789",
"profileImageSettings": ImageSettings,
"profileImageUrl": "abc123",
"profilePercent": 987,
"pronouns": "xyz789",
"publicProfileSegments": [PublicProfileSegment],
"publicTagList": ["xyz789"],
"rate30": 987,
"rate60": 123,
"rates": {},
"role": "abc123",
"sessionLengths": [987],
"sessionsRemaining": 987,
"shortTermGoals": "xyz789",
"skills": "abc123",
"slug": "xyz789",
"socialLinks": [SocialLink],
"softSkills": "abc123",
"status": "xyz789",
"subdisciplineNames": ["abc123"],
"subdisciplines": [Subdiscipline],
"tags": [Tag],
"tier": "xyz789",
"timeSlot": TimeSlot,
"timeSlots": [TimeSlot],
"timezone": "xyz789",
"twitterLink": "abc123",
"uid": "4",
"userRole": "abc123",
"vimeoLink": "xyz789",
"website": "xyz789",
"welcomeMessage": "abc123",
"youtubeLink": "abc123"
}
}
}
mentors
Description
Mentors visible to the caller, paginated.
Example
Query
query mentors(
$groupId: ID,
$page: Int,
$per: Int
) {
mentors(
groupId: $groupId,
page: $page,
per: $per
) {
accounts {
...AccountFragment
}
activeGoals {
...UserGoalFragment
}
activeSubscription
allowGroupSessions
availabilities {
...AvailabilityFragment
}
availabilityCounts {
...DateCountFragment
}
avatar {
...AvatarFragment
}
behanceLink
bookable
bookingLink
bookings {
...BookingFragment
}
cancellationPolicy
cohort {
...CohortFragment
}
company
completedGoals {
...UserGoalFragment
}
country {
...CountryFragment
}
countryCode
createdUsing
description
discipline {
...DisciplineFragment
}
disciplineNames
disciplines {
...DisciplineFragment
}
dribbbleLink
effectiveMenteeCapacity
effectiveMentorCapacity
experience
facebookLink
files {
...UserFileFragment
}
firstName
goals {
...UserGoalFragment
}
group {
...GroupFragment
}
groupSessions {
...BookingFragment
}
hardSkills
hasAvailability
id
instagramLink
isActive
isMatched
languages {
...LanguageFragment
}
lastName
lastSignInAt
linkedinLink
location
longTermGoals
market
masterclasses {
...BookingFragment
}
matchingPercent
menteeCapacity
menteeMatchesRemaining
menteeSessionsRemaining
mentor
mentorCapacity
mentorMatchesRemaining
mentorSessionsRemaining
mentorlyAdmin
missingMatchingFields
missingProfileFields
name
newProfileImage {
...UploadedFileFragment
}
newProfileImageUrl
onboardingPercent
paymentRequired
peopleNetwork
preferredLanguage {
...LanguageFragment
}
profileImagePath
profileImageSettings {
...ImageSettingsFragment
}
profileImageUrl
profilePercent
pronouns
publicProfileSegments {
...PublicProfileSegmentFragment
}
publicTagList
rate30
rate60
rates
role
sessionLengths
sessionsRemaining
shortTermGoals
skills
slug
socialLinks {
...SocialLinkFragment
}
softSkills
status
subdisciplineNames
subdisciplines {
...SubdisciplineFragment
}
tags {
...TagFragment
}
tier
timeSlot {
...TimeSlotFragment
}
timeSlots {
...TimeSlotFragment
}
timezone
twitterLink
uid
userRole
vimeoLink
website
welcomeMessage
youtubeLink
}
}
Variables
{"groupId": "4", "page": 987, "per": 987}
Response
{
"data": {
"mentors": [
{
"accounts": [Account],
"activeGoals": [UserGoal],
"activeSubscription": true,
"allowGroupSessions": false,
"availabilities": [Availability],
"availabilityCounts": [DateCount],
"avatar": Avatar,
"behanceLink": "xyz789",
"bookable": true,
"bookingLink": "abc123",
"bookings": [Booking],
"cancellationPolicy": "xyz789",
"cohort": Cohort,
"company": "abc123",
"completedGoals": [UserGoal],
"country": Country,
"countryCode": "xyz789",
"createdUsing": "xyz789",
"description": "abc123",
"discipline": Discipline,
"disciplineNames": ["abc123"],
"disciplines": [Discipline],
"dribbbleLink": "xyz789",
"effectiveMenteeCapacity": 123,
"effectiveMentorCapacity": 987,
"experience": 123,
"facebookLink": "xyz789",
"files": [UserFile],
"firstName": "xyz789",
"goals": [UserGoal],
"group": Group,
"groupSessions": [Booking],
"hardSkills": "xyz789",
"hasAvailability": false,
"id": 4,
"instagramLink": "abc123",
"isActive": true,
"isMatched": true,
"languages": [Language],
"lastName": "xyz789",
"lastSignInAt": ISO8601DateTime,
"linkedinLink": "abc123",
"location": "xyz789",
"longTermGoals": "abc123",
"market": "xyz789",
"masterclasses": [Booking],
"matchingPercent": 987,
"menteeCapacity": 987,
"menteeMatchesRemaining": 123,
"menteeSessionsRemaining": 123,
"mentor": true,
"mentorCapacity": 123,
"mentorMatchesRemaining": 987,
"mentorSessionsRemaining": 987,
"mentorlyAdmin": false,
"missingMatchingFields": ["abc123"],
"missingProfileFields": ["abc123"],
"name": "abc123",
"newProfileImage": UploadedFile,
"newProfileImageUrl": "xyz789",
"onboardingPercent": 987,
"paymentRequired": false,
"peopleNetwork": ["xyz789"],
"preferredLanguage": Language,
"profileImagePath": "xyz789",
"profileImageSettings": ImageSettings,
"profileImageUrl": "xyz789",
"profilePercent": 123,
"pronouns": "xyz789",
"publicProfileSegments": [PublicProfileSegment],
"publicTagList": ["abc123"],
"rate30": 123,
"rate60": 987,
"rates": {},
"role": "xyz789",
"sessionLengths": [123],
"sessionsRemaining": 123,
"shortTermGoals": "abc123",
"skills": "xyz789",
"slug": "xyz789",
"socialLinks": [SocialLink],
"softSkills": "xyz789",
"status": "abc123",
"subdisciplineNames": ["abc123"],
"subdisciplines": [Subdiscipline],
"tags": [Tag],
"tier": "xyz789",
"timeSlot": TimeSlot,
"timeSlots": [TimeSlot],
"timezone": "xyz789",
"twitterLink": "abc123",
"uid": 4,
"userRole": "xyz789",
"vimeoLink": "xyz789",
"website": "abc123",
"welcomeMessage": "xyz789",
"youtubeLink": "abc123"
}
]
}
}
milestoneContents
Description
Marketing milestone blocks for the public website.
Response
Returns [MilestoneContent!]!
Example
Query
query milestoneContents {
milestoneContents {
id
imageUrl
key
language
source
text
url
}
}
Response
{
"data": {
"milestoneContents": [
{
"id": "4",
"imageUrl": "abc123",
"key": "4",
"language": "4",
"source": "xyz789",
"text": "xyz789",
"url": 4
}
]
}
}
pageContent
Description
Marketing page content by key.
Response
Returns a PageContent
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query pageContent($id: ID!) {
pageContent(id: $id) {
body
bodyHtml
description
id
key
publishedAt
title
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"pageContent": {
"body": "abc123",
"bodyHtml": "xyz789",
"description": "xyz789",
"id": "4",
"key": 4,
"publishedAt": ISO8601DateTime,
"title": "abc123",
"updatedAt": ISO8601DateTime
}
}
}
pageContents
Description
All marketing page-content records for the public website.
Response
Returns [PageContent!]
Example
Query
query pageContents {
pageContents {
body
bodyHtml
description
id
key
publishedAt
title
updatedAt
}
}
Response
{
"data": {
"pageContents": [
{
"body": "xyz789",
"bodyHtml": "xyz789",
"description": "xyz789",
"id": 4,
"key": 4,
"publishedAt": ISO8601DateTime,
"title": "abc123",
"updatedAt": ISO8601DateTime
}
]
}
}
partnerContents
Description
Marketing partner-logo blocks for the public website.
Response
Returns [PartnerContent!]!
Example
Query
query partnerContents {
partnerContents {
id
imageUrl
key
name
url
}
}
Response
{
"data": {
"partnerContents": [
{
"id": 4,
"imageUrl": "xyz789",
"key": 4,
"name": "abc123",
"url": "xyz789"
}
]
}
}
planContents
Description
Marketing plan/pricing content for the public website.
Response
Returns [PlanContent!]!
Example
Query
query planContents {
planContents {
description
id
key
mainFeatures
name
price
users
}
}
Response
{
"data": {
"planContents": [
{
"description": "abc123",
"id": "4",
"key": "4",
"mainFeatures": "xyz789",
"name": "xyz789",
"price": "abc123",
"users": "xyz789"
}
]
}
}
reviewSentimentAnalysis
Description
Analyze the sentiment from mentorship reviews
Response
Returns a ReviewSentiment
Example
Query
query reviewSentimentAnalysis(
$groupId: ID!,
$locale: String
) {
reviewSentimentAnalysis(
groupId: $groupId,
locale: $locale
) {
negativeThemes {
...ReviewThemeFragment
}
neutralThemes {
...ReviewThemeFragment
}
positiveThemes {
...ReviewThemeFragment
}
sentimentSummary
}
}
Variables
{"groupId": 4, "locale": "en"}
Response
{
"data": {
"reviewSentimentAnalysis": {
"negativeThemes": [ReviewTheme],
"neutralThemes": [ReviewTheme],
"positiveThemes": [ReviewTheme],
"sentimentSummary": "xyz789"
}
}
}
subdisciplines
Description
Subdisciplines
Response
Returns [Subdiscipline!]
Example
Query
query subdisciplines(
$groupId: ID,
$locale: String
) {
subdisciplines(
groupId: $groupId,
locale: $locale
) {
id
name
slug
userCount
}
}
Variables
{"groupId": 4, "locale": "xyz789"}
Response
{
"data": {
"subdisciplines": [
{
"id": 4,
"name": "xyz789",
"slug": "xyz789",
"userCount": 123
}
]
}
}
teamCategories
Description
Team-page category groupings for the public website.
Response
Returns a TeamCategories!
Example
Query
query teamCategories {
teamCategories {
advisors {
...TeamContentFragment
}
founders {
...TeamContentFragment
}
}
}
Response
{
"data": {
"teamCategories": {
"advisors": [TeamContent],
"founders": [TeamContent]
}
}
}
teamContents
Description
Team-page entries for the public website.
Response
Returns [TeamContent!]!
Example
Query
query teamContents {
teamContents {
id
imageUrl
key
name
position
title
url
}
}
Response
{
"data": {
"teamContents": [
{
"id": "4",
"imageUrl": "abc123",
"key": 4,
"name": "xyz789",
"position": 987,
"title": "abc123",
"url": "xyz789"
}
]
}
}
testimonialContents
Description
Customer testimonials, optionally filtered by category.
Response
Returns [TestimonialContent!]!
Arguments
| Name | Description |
|---|---|
category - String
|
Example
Query
query testimonialContents($category: String) {
testimonialContents(category: $category) {
body
category
id
imageUrl
key
name
}
}
Variables
{"category": "abc123"}
Response
{
"data": {
"testimonialContents": [
{
"body": "abc123",
"category": "xyz789",
"id": 4,
"imageUrl": "xyz789",
"key": 4,
"name": "xyz789"
}
]
}
}
useCaseCategories
Description
Use-case category groupings for the public website.
Response
Returns a UseCaseCategories!
Example
Query
query useCaseCategories {
useCaseCategories {
communities {
...UseCaseContentFragment
}
networks {
...UseCaseContentFragment
}
schools {
...UseCaseContentFragment
}
specialProgramming {
...UseCaseContentFragment
}
}
}
Response
{
"data": {
"useCaseCategories": {
"communities": [UseCaseContent],
"networks": [UseCaseContent],
"schools": [UseCaseContent],
"specialProgramming": [UseCaseContent]
}
}
}
useCaseContents
Description
Use-case content blocks for the public website.
Response
Returns [UseCaseContent!]!
Example
Query
query useCaseContents {
useCaseContents {
body
category
embedCode
id
key
name
organization
position
quote {
...TestimonialContentFragment
}
videoUrl
}
}
Response
{
"data": {
"useCaseContents": [
{
"body": "abc123",
"category": "xyz789",
"embedCode": "xyz789",
"id": 4,
"key": "4",
"name": "xyz789",
"organization": "xyz789",
"position": 987,
"quote": TestimonialContent,
"videoUrl": "abc123"
}
]
}
}
user
Description
A single user by id; visible to peers in the same group.
Example
Query
query user($id: ID!) {
user(id: $id) {
accounts {
...AccountFragment
}
activeGoals {
...UserGoalFragment
}
activeSubscription
allowGroupSessions
availabilities {
...AvailabilityFragment
}
availabilityCounts {
...DateCountFragment
}
avatar {
...AvatarFragment
}
behanceLink
bookable
bookingLink
bookings {
...BookingFragment
}
cancellationPolicy
cohort {
...CohortFragment
}
company
completedGoals {
...UserGoalFragment
}
country {
...CountryFragment
}
countryCode
createdUsing
description
discipline {
...DisciplineFragment
}
disciplineNames
disciplines {
...DisciplineFragment
}
dribbbleLink
effectiveMenteeCapacity
effectiveMentorCapacity
experience
facebookLink
files {
...UserFileFragment
}
firstName
goals {
...UserGoalFragment
}
group {
...GroupFragment
}
groupSessions {
...BookingFragment
}
hardSkills
hasAvailability
id
instagramLink
isActive
isMatched
languages {
...LanguageFragment
}
lastName
lastSignInAt
linkedinLink
location
longTermGoals
market
masterclasses {
...BookingFragment
}
matchingPercent
menteeCapacity
menteeMatchesRemaining
menteeSessionsRemaining
mentor
mentorCapacity
mentorMatchesRemaining
mentorSessionsRemaining
mentorlyAdmin
missingMatchingFields
missingProfileFields
name
newProfileImage {
...UploadedFileFragment
}
newProfileImageUrl
onboardingPercent
paymentRequired
peopleNetwork
preferredLanguage {
...LanguageFragment
}
profileImagePath
profileImageSettings {
...ImageSettingsFragment
}
profileImageUrl
profilePercent
pronouns
publicProfileSegments {
...PublicProfileSegmentFragment
}
publicTagList
rate30
rate60
rates
role
sessionLengths
sessionsRemaining
shortTermGoals
skills
slug
socialLinks {
...SocialLinkFragment
}
softSkills
status
subdisciplineNames
subdisciplines {
...SubdisciplineFragment
}
tags {
...TagFragment
}
tier
timeSlot {
...TimeSlotFragment
}
timeSlots {
...TimeSlotFragment
}
timezone
twitterLink
uid
userRole
vimeoLink
website
welcomeMessage
youtubeLink
}
}
Variables
{"id": 4}
Response
{
"data": {
"user": {
"accounts": [Account],
"activeGoals": [UserGoal],
"activeSubscription": false,
"allowGroupSessions": false,
"availabilities": [Availability],
"availabilityCounts": [DateCount],
"avatar": Avatar,
"behanceLink": "abc123",
"bookable": false,
"bookingLink": "abc123",
"bookings": [Booking],
"cancellationPolicy": "abc123",
"cohort": Cohort,
"company": "abc123",
"completedGoals": [UserGoal],
"country": Country,
"countryCode": "xyz789",
"createdUsing": "xyz789",
"description": "xyz789",
"discipline": Discipline,
"disciplineNames": ["abc123"],
"disciplines": [Discipline],
"dribbbleLink": "xyz789",
"effectiveMenteeCapacity": 123,
"effectiveMentorCapacity": 987,
"experience": 123,
"facebookLink": "xyz789",
"files": [UserFile],
"firstName": "abc123",
"goals": [UserGoal],
"group": Group,
"groupSessions": [Booking],
"hardSkills": "xyz789",
"hasAvailability": true,
"id": "4",
"instagramLink": "xyz789",
"isActive": false,
"isMatched": true,
"languages": [Language],
"lastName": "xyz789",
"lastSignInAt": ISO8601DateTime,
"linkedinLink": "abc123",
"location": "abc123",
"longTermGoals": "xyz789",
"market": "xyz789",
"masterclasses": [Booking],
"matchingPercent": 123,
"menteeCapacity": 123,
"menteeMatchesRemaining": 987,
"menteeSessionsRemaining": 987,
"mentor": false,
"mentorCapacity": 123,
"mentorMatchesRemaining": 987,
"mentorSessionsRemaining": 123,
"mentorlyAdmin": true,
"missingMatchingFields": ["xyz789"],
"missingProfileFields": ["abc123"],
"name": "abc123",
"newProfileImage": UploadedFile,
"newProfileImageUrl": "abc123",
"onboardingPercent": 987,
"paymentRequired": true,
"peopleNetwork": ["abc123"],
"preferredLanguage": Language,
"profileImagePath": "xyz789",
"profileImageSettings": ImageSettings,
"profileImageUrl": "abc123",
"profilePercent": 987,
"pronouns": "xyz789",
"publicProfileSegments": [PublicProfileSegment],
"publicTagList": ["abc123"],
"rate30": 987,
"rate60": 123,
"rates": {},
"role": "xyz789",
"sessionLengths": [987],
"sessionsRemaining": 123,
"shortTermGoals": "xyz789",
"skills": "abc123",
"slug": "abc123",
"socialLinks": [SocialLink],
"softSkills": "abc123",
"status": "abc123",
"subdisciplineNames": ["abc123"],
"subdisciplines": [Subdiscipline],
"tags": [Tag],
"tier": "xyz789",
"timeSlot": TimeSlot,
"timeSlots": [TimeSlot],
"timezone": "xyz789",
"twitterLink": "xyz789",
"uid": "4",
"userRole": "abc123",
"vimeoLink": "xyz789",
"website": "abc123",
"welcomeMessage": "abc123",
"youtubeLink": "xyz789"
}
}
}
userGoal
Description
A single user goal by id; visible to its owner and program managers.
Example
Query
query userGoal($id: ID!) {
userGoal(id: $id) {
achievementReflection
completedAt
createdAt
deletedAt
goalText
id
isActive
isCompleted
isDeleted
progressNotes {
...GoalProgressNoteFragment
}
updatedAt
user {
...UserFragment
}
userId
}
}
Variables
{"id": 4}
Response
{
"data": {
"userGoal": {
"achievementReflection": "abc123",
"completedAt": ISO8601DateTime,
"createdAt": ISO8601DateTime,
"deletedAt": ISO8601DateTime,
"goalText": "abc123",
"id": 4,
"isActive": true,
"isCompleted": false,
"isDeleted": true,
"progressNotes": [GoalProgressNote],
"updatedAt": ISO8601DateTime,
"user": User,
"userId": 4
}
}
}
userGoalsAnalysis
Description
Analysis of user goals for a group
Response
Returns a UserGoalsAnalysis!
Example
Query
query userGoalsAnalysis(
$groupId: ID!,
$locale: String
) {
userGoalsAnalysis(
groupId: $groupId,
locale: $locale
) {
longTerm {
...GoalAnalysisFragment
}
metadata {
...AnalysisMetadataFragment
}
shortTerm {
...GoalAnalysisFragment
}
}
}
Variables
{"groupId": "4", "locale": "en"}
Response
{
"data": {
"userGoalsAnalysis": {
"longTerm": GoalAnalysis,
"metadata": AnalysisMetadata,
"shortTerm": GoalAnalysis
}
}
}
validateResetPasswordToken
Description
Validate a password-reset token against an email; returns a status string.
Example
Query
query validateResetPasswordToken(
$email: String!,
$groupId: ID,
$token: ID!
) {
validateResetPasswordToken(
email: $email,
groupId: $groupId,
token: $token
)
}
Variables
{
"email": "xyz789",
"groupId": "4",
"token": "4"
}
Response
{
"data": {
"validateResetPasswordToken": "xyz789"
}
}
viewer
Description
The current user
Response
Returns a CurrentUser
Example
Query
query viewer {
viewer {
account {
...AccountFragment
}
accounts {
...AccountFragment
}
activeGoals {
...UserGoalFragment
}
activeSubscription
allowGroupSessions
alternates {
...AlternateUserFragment
}
availabilities {
...AvailabilityFragment
}
availabilityCalendarId
availabilityCounts {
...DateCountFragment
}
avatar {
...AvatarFragment
}
behanceLink
bookable
booking {
...BookingFragment
}
bookingCount
bookingLink
bookingRequestCount
bookingRequests {
...BookingRequestFragment
}
bookings {
...BookingFragment
}
calendarConnection {
...CalendarConnectionFragment
}
calendarId
calendarProvider
calendarUrl
cancellationPolicy
cohort {
...CohortFragment
}
company
completedGoals {
...UserGoalFragment
}
conference {
...ConferenceFragment
}
conferences {
...ConferenceFragment
}
connectedCalendars {
...ConnectedCalendarFragment
}
connections {
...UserConnectionsFragment
}
contactEmail
conversation {
...ConversationFragment
}
conversationCount
conversations {
...ConversationFragment
}
country {
...CountryFragment
}
countryCode
createdAt
createdUsing
dateOfBirth
description
discipline {
...DisciplineFragment
}
disciplineNames
disciplines {
...DisciplineFragment
}
dribbbleLink
effectiveMenteeCapacity
effectiveMentorCapacity
email
experience
extensionNumber
facebookLink
files {
...UserFileFragment
}
firstName
gender
goals {
...UserGoalFragment
}
group {
...GroupFragment
}
groupSessions {
...BookingFragment
}
hardSkills
hasAvailability
id
instagramLink
intercomHash
invoiceList {
...InvoiceListFragment
}
isActive
isMatched
languages {
...LanguageFragment
}
lastName
lastSignInAt
legacyGroup
linkedinLink
location
longTermGoals
managedGroup {
...ManagedGroupFragment
}
managedGroups {
...ManagedGroupFragment
}
market
masterclasses {
...BookingFragment
}
matchingPercent
meetingProvider
menteeCapacity
menteeMatches {
...MentorMatchFragment
}
menteeMatchesRemaining
menteeSessionsRemaining
mentor
mentorCapacity
mentorMatches {
...MentorMatchFragment
}
mentorMatchesRemaining
mentorSessionsRemaining
mentorlyAdmin
missingMatchingFields
missingProfileFields
name
needsAuth
needsCalendarConnection
newProfileImage {
...UploadedFileFragment
}
newProfileImageUrl
nextSteps {
...NextStepFragment
}
nylasEnabled
onboarded
onboardingPercent
otpRequiredForLogin
paymentRequired
peopleNetwork
phoneNumber
preferredLanguage {
...LanguageFragment
}
profileImagePath
profileImageSettings {
...ImageSettingsFragment
}
profileImageUrl
profilePercent
pronouns
publicProfileSegments {
...PublicProfileSegmentFragment
}
publicTagList
rate30
rate60
rates
role
sessionLengths
sessionsRemaining
shortTermGoals
signInThrough
signUpThrough
skills
slackConnection {
...SlackConnectionFragment
}
slug
socialLinks {
...SocialLinkFragment
}
softSkills
status
stripeAccount {
...StripeAccountFragment
}
stripeAccountLink
stripeCustomer {
...StripeCustomerFragment
}
subdisciplineNames
subdisciplines {
...SubdisciplineFragment
}
surveyResult {
...SurveyResultFragment
}
tags {
...TagFragment
}
tier
timeSlot {
...TimeSlotFragment
}
timeSlots {
...TimeSlotFragment
}
timezone
token
twitterLink
uid
unconfirmedBookings {
...BookingFragment
}
unreadConversationCount
userRole
vimeoLink
website
welcomeMessage
workingHours {
...WorkingHourFragment
}
youtubeLink
}
}
Response
{
"data": {
"viewer": {
"account": Account,
"accounts": [Account],
"activeGoals": [UserGoal],
"activeSubscription": true,
"allowGroupSessions": true,
"alternates": [AlternateUser],
"availabilities": [Availability],
"availabilityCalendarId": "4",
"availabilityCounts": [DateCount],
"avatar": Avatar,
"behanceLink": "abc123",
"bookable": false,
"booking": Booking,
"bookingCount": 987,
"bookingLink": "abc123",
"bookingRequestCount": 123,
"bookingRequests": [BookingRequest],
"bookings": [Booking],
"calendarConnection": CalendarConnection,
"calendarId": "4",
"calendarProvider": "xyz789",
"calendarUrl": "xyz789",
"cancellationPolicy": "xyz789",
"cohort": Cohort,
"company": "abc123",
"completedGoals": [UserGoal],
"conference": Conference,
"conferences": [Conference],
"connectedCalendars": [ConnectedCalendar],
"connections": UserConnections,
"contactEmail": "abc123",
"conversation": Conversation,
"conversationCount": 123,
"conversations": [Conversation],
"country": Country,
"countryCode": "abc123",
"createdAt": ISO8601DateTime,
"createdUsing": "abc123",
"dateOfBirth": ISO8601Date,
"description": "abc123",
"discipline": Discipline,
"disciplineNames": ["xyz789"],
"disciplines": [Discipline],
"dribbbleLink": "abc123",
"effectiveMenteeCapacity": 123,
"effectiveMentorCapacity": 123,
"email": "abc123",
"experience": 123,
"extensionNumber": "xyz789",
"facebookLink": "abc123",
"files": [UserFile],
"firstName": "xyz789",
"gender": "xyz789",
"goals": [UserGoal],
"group": Group,
"groupSessions": [Booking],
"hardSkills": "abc123",
"hasAvailability": false,
"id": "4",
"instagramLink": "xyz789",
"intercomHash": "xyz789",
"invoiceList": InvoiceList,
"isActive": false,
"isMatched": true,
"languages": [Language],
"lastName": "abc123",
"lastSignInAt": ISO8601DateTime,
"legacyGroup": false,
"linkedinLink": "xyz789",
"location": "abc123",
"longTermGoals": "abc123",
"managedGroup": ManagedGroup,
"managedGroups": [ManagedGroup],
"market": "xyz789",
"masterclasses": [Booking],
"matchingPercent": 987,
"meetingProvider": "abc123",
"menteeCapacity": 987,
"menteeMatches": [MentorMatch],
"menteeMatchesRemaining": 123,
"menteeSessionsRemaining": 123,
"mentor": false,
"mentorCapacity": 123,
"mentorMatches": [MentorMatch],
"mentorMatchesRemaining": 987,
"mentorSessionsRemaining": 987,
"mentorlyAdmin": false,
"missingMatchingFields": ["abc123"],
"missingProfileFields": ["xyz789"],
"name": "xyz789",
"needsAuth": false,
"needsCalendarConnection": false,
"newProfileImage": UploadedFile,
"newProfileImageUrl": "abc123",
"nextSteps": [NextStep],
"nylasEnabled": false,
"onboarded": true,
"onboardingPercent": 987,
"otpRequiredForLogin": true,
"paymentRequired": true,
"peopleNetwork": ["abc123"],
"phoneNumber": "abc123",
"preferredLanguage": Language,
"profileImagePath": "xyz789",
"profileImageSettings": ImageSettings,
"profileImageUrl": "abc123",
"profilePercent": 987,
"pronouns": "abc123",
"publicProfileSegments": [PublicProfileSegment],
"publicTagList": ["xyz789"],
"rate30": 123,
"rate60": 987,
"rates": {},
"role": "xyz789",
"sessionLengths": [987],
"sessionsRemaining": 123,
"shortTermGoals": "xyz789",
"signInThrough": "abc123",
"signUpThrough": "xyz789",
"skills": "xyz789",
"slackConnection": SlackConnection,
"slug": "abc123",
"socialLinks": [SocialLink],
"softSkills": "abc123",
"status": "abc123",
"stripeAccount": StripeAccount,
"stripeAccountLink": "abc123",
"stripeCustomer": StripeCustomer,
"subdisciplineNames": ["abc123"],
"subdisciplines": [Subdiscipline],
"surveyResult": SurveyResult,
"tags": [Tag],
"tier": "xyz789",
"timeSlot": TimeSlot,
"timeSlots": [TimeSlot],
"timezone": "xyz789",
"token": 4,
"twitterLink": "xyz789",
"uid": "4",
"unconfirmedBookings": [Booking],
"unreadConversationCount": 987,
"userRole": "abc123",
"vimeoLink": "abc123",
"website": "abc123",
"welcomeMessage": "abc123",
"workingHours": [WorkingHour],
"youtubeLink": "abc123"
}
}
}
Mutations
acceptBookingRequest
Description
Accept a booking request
Response
Returns an AcceptBookingRequestPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation acceptBookingRequest($id: ID!) {
acceptBookingRequest(id: $id) {
booking {
...BookingFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"acceptBookingRequest": {
"booking": Booking,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
}
}
activateInAppBiling
Description
Activate in app billing
Response
Returns an ActivateInAppBillingPayload!
Example
Query
mutation activateInAppBiling {
activateInAppBiling {
account {
...AccountFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Response
{
"data": {
"activateInAppBiling": {
"account": Account,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
}
}
activateMatches
Description
Activate matches with the given ids
Response
Returns an ActivateMatchesPayload!
Example
Query
mutation activateMatches(
$ids: [ID!]!,
$manual: Boolean
) {
activateMatches(
ids: $ids,
manual: $manual
) {
errorDetails
errors
updatedRecordCount
viewer {
...CurrentUserFragment
}
}
}
Variables
{"ids": ["4"], "manual": true}
Response
{
"data": {
"activateMatches": {
"errorDetails": {},
"errors": ["xyz789"],
"updatedRecordCount": 987,
"viewer": CurrentUser
}
}
}
activateStagedMatches
Description
Activate staged matches
Response
Returns an ActivateStagedMatchesPayload!
Arguments
| Name | Description |
|---|---|
groupId - ID!
|
Example
Query
mutation activateStagedMatches($groupId: ID!) {
activateStagedMatches(groupId: $groupId) {
errorDetails
errors
updatedRecordCount
viewer {
...CurrentUserFragment
}
}
}
Variables
{"groupId": 4}
Response
{
"data": {
"activateStagedMatches": {
"errorDetails": {},
"errors": ["abc123"],
"updatedRecordCount": 987,
"viewer": CurrentUser
}
}
}
activateTopMatches
Description
Activates top matches
Response
Returns an ActivateTopMatchesPayload!
Example
Query
mutation activateTopMatches(
$count: Int!,
$groupId: ID!
) {
activateTopMatches(
count: $count,
groupId: $groupId
) {
errorDetails
errors
status
viewer {
...CurrentUserFragment
}
}
}
Variables
{"count": 987, "groupId": 4}
Response
{
"data": {
"activateTopMatches": {
"errorDetails": {},
"errors": ["xyz789"],
"status": "xyz789",
"viewer": CurrentUser
}
}
}
addAuthenticator
Description
Add an authenticator
Response
Returns an AddAuthenticatorPayload!
Arguments
| Name | Description |
|---|---|
verificationCode - String!
|
Example
Query
mutation addAuthenticator($verificationCode: String!) {
addAuthenticator(verificationCode: $verificationCode) {
errorDetails
errors
user {
...CurrentUserFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"verificationCode": "xyz789"}
Response
{
"data": {
"addAuthenticator": {
"errorDetails": {},
"errors": ["abc123"],
"user": CurrentUser,
"viewer": CurrentUser
}
}
}
addBooking
Description
Add a booking
Response
Returns an AddBookingPayload!
Arguments
| Name | Description |
|---|---|
attributes - BookingAttributes!
|
Example
Query
mutation addBooking($attributes: BookingAttributes!) {
addBooking(attributes: $attributes) {
booking {
...BookingFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": BookingAttributes}
Response
{
"data": {
"addBooking": {
"booking": Booking,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
}
}
addMessage
Description
Add a message
Example
Query
mutation addMessage(
$conversationId: ID!,
$id: ID!,
$text: String!
) {
addMessage(
conversationId: $conversationId,
id: $id,
text: $text
) {
createdAt
id
text
user {
...UserFragment
}
}
}
Variables
{
"conversationId": "4",
"id": "4",
"text": "abc123"
}
Response
{
"data": {
"addMessage": {
"createdAt": ISO8601DateTime,
"id": 4,
"text": "abc123",
"user": User
}
}
}
aiTranslateProgram
Description
Ai a translate program
Response
Returns an AiTranslateProgramPayload!
Example
Query
mutation aiTranslateProgram(
$groupId: ID!,
$targetLocales: [String!]
) {
aiTranslateProgram(
groupId: $groupId,
targetLocales: $targetLocales
) {
errorDetails
errors
results {
...AiTranslationResultFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"groupId": "4",
"targetLocales": ["xyz789"]
}
Response
{
"data": {
"aiTranslateProgram": {
"errorDetails": {},
"errors": ["xyz789"],
"results": [AiTranslationResult],
"viewer": CurrentUser
}
}
}
archiveGroup
Description
Archive a group
Response
Returns an ArchiveGroupPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation archiveGroup($id: ID!) {
archiveGroup(id: $id) {
errorDetails
errors
group {
...ManagedGroupFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"archiveGroup": {
"errorDetails": {},
"errors": ["xyz789"],
"group": ManagedGroup,
"viewer": CurrentUser
}
}
}
archiveGroupUsers
Description
Archive a group users
Response
Returns an ArchiveGroupUsersPayload!
Arguments
| Name | Description |
|---|---|
ids - [ID!]
|
|
memberFilters - MemberFiltersAttributes
|
Example
Query
mutation archiveGroupUsers(
$ids: [ID!],
$memberFilters: MemberFiltersAttributes
) {
archiveGroupUsers(
ids: $ids,
memberFilters: $memberFilters
) {
archivedUsersCount
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"ids": ["4"],
"memberFilters": MemberFiltersAttributes
}
Response
{
"data": {
"archiveGroupUsers": {
"archivedUsersCount": 123,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
}
}
archiveUser
Description
Archive a user
Response
Returns an ArchiveUserPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation archiveUser($id: ID!) {
archiveUser(id: $id) {
errorDetails
errors
user {
...ManagedUserFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"archiveUser": {
"errorDetails": {},
"errors": ["xyz789"],
"user": ManagedUser,
"viewer": CurrentUser
}
}
}
authenticateUser
Description
log the user in with the given credentials
Response
Returns an AuthenticateUserPayload!
Example
Query
mutation authenticateUser(
$email: String!,
$groupId: ID,
$password: String!,
$verificationCode: String
) {
authenticateUser(
email: $email,
groupId: $groupId,
password: $password,
verificationCode: $verificationCode
) {
errorDetails
errors
loginUrl
otpRequiredForLogin
user {
...CurrentUserFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"email": "xyz789",
"groupId": 4,
"password": "abc123",
"verificationCode": "xyz789"
}
Response
{
"data": {
"authenticateUser": {
"errorDetails": {},
"errors": ["xyz789"],
"loginUrl": "abc123",
"otpRequiredForLogin": true,
"user": CurrentUser,
"viewer": CurrentUser
}
}
}
calculateGroupMatches
Description
Calculates matching scores withing a group
Response
Returns a CalculateGroupMatchesPayload!
Arguments
| Name | Description |
|---|---|
groupId - ID!
|
Example
Query
mutation calculateGroupMatches($groupId: ID!) {
calculateGroupMatches(groupId: $groupId) {
errorDetails
errors
status
viewer {
...CurrentUserFragment
}
}
}
Variables
{"groupId": "4"}
Response
{
"data": {
"calculateGroupMatches": {
"errorDetails": {},
"errors": ["abc123"],
"status": "abc123",
"viewer": CurrentUser
}
}
}
cancelBooking
Description
Cancel a booking
Response
Returns a CancelBookingPayload!
Example
Query
mutation cancelBooking(
$id: ID!,
$reason: String!
) {
cancelBooking(
id: $id,
reason: $reason
) {
booking {
...BookingFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4, "reason": "xyz789"}
Response
{
"data": {
"cancelBooking": {
"booking": Booking,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
}
}
cancelBookingRequest
Description
Cancel a booking request
Response
Returns a CancelBookingRequestPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation cancelBookingRequest($id: ID!) {
cancelBookingRequest(id: $id) {
bookingRequest {
...BookingRequestFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"cancelBookingRequest": {
"bookingRequest": BookingRequest,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
}
}
cancelPendingInvitationEmails
Description
Cancel a pending invitation emails
Response
Returns a CancelPendingInvitationEmailsPayload!
Arguments
| Name | Description |
|---|---|
groupId - ID!
|
Example
Query
mutation cancelPendingInvitationEmails($groupId: ID!) {
cancelPendingInvitationEmails(groupId: $groupId) {
errorDetails
errors
status
viewer {
...CurrentUserFragment
}
}
}
Variables
{"groupId": "4"}
Response
{
"data": {
"cancelPendingInvitationEmails": {
"errorDetails": {},
"errors": ["xyz789"],
"status": "abc123",
"viewer": CurrentUser
}
}
}
cancelStagedMatches
Description
Cancel staged matches
Response
Returns a CancelStagedMatchesPayload!
Arguments
| Name | Description |
|---|---|
groupId - ID!
|
Example
Query
mutation cancelStagedMatches($groupId: ID!) {
cancelStagedMatches(groupId: $groupId) {
errorDetails
errors
updatedRecordCount
viewer {
...CurrentUserFragment
}
}
}
Variables
{"groupId": 4}
Response
{
"data": {
"cancelStagedMatches": {
"errorDetails": {},
"errors": ["abc123"],
"updatedRecordCount": 987,
"viewer": CurrentUser
}
}
}
completeUserGoal
Description
Mark a user goal as completed
Response
Returns a CompleteUserGoalPayload!
Example
Query
mutation completeUserGoal(
$achievementReflection: String,
$goalId: ID!
) {
completeUserGoal(
achievementReflection: $achievementReflection,
goalId: $goalId
) {
errorDetails
errors
goal {
...UserGoalFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"achievementReflection": "abc123",
"goalId": "4"
}
Response
{
"data": {
"completeUserGoal": {
"errorDetails": {},
"errors": ["xyz789"],
"goal": UserGoal,
"viewer": CurrentUser
}
}
}
connectSlackByEmail
Description
Manually link the current user to their Slack account by email. Used when bulk matching couldn't find them automatically.
Response
Returns a ConnectSlackByEmailPayload!
Arguments
| Name | Description |
|---|---|
email - String!
|
The email the user is registered with in Slack |
Example
Query
mutation connectSlackByEmail($email: String!) {
connectSlackByEmail(email: $email) {
errorDetails
errors
slackConnection {
...SlackConnectionFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"email": "abc123"}
Response
{
"data": {
"connectSlackByEmail": {
"errorDetails": {},
"errors": ["xyz789"],
"slackConnection": SlackConnection,
"viewer": CurrentUser
}
}
}
createApiKey
Description
Create an API key (admin only). Returns the plaintext token ONCE
Response
Returns a CreateApiKeyPayload!
Arguments
| Name | Description |
|---|---|
accountId - ID!
|
Account the key belongs to. |
expiresAt - ISO8601DateTime
|
Optional expiration. |
groupIds - [ID!]
|
Restrict to specific groups; omit for account-wide. |
name - String!
|
Human-readable label, e.g. 'HR Dashboard'. |
rateLimitTier - String
|
Throttle bucket — standard (default) or enterprise. |
scopes - [String!]!
|
Permission scopes (see API documentation). |
userId - ID
|
When set, the key is user-delegated and the API behaves as this user. |
Example
Query
mutation createApiKey(
$accountId: ID!,
$expiresAt: ISO8601DateTime,
$groupIds: [ID!],
$name: String!,
$rateLimitTier: String,
$scopes: [String!]!,
$userId: ID
) {
createApiKey(
accountId: $accountId,
expiresAt: $expiresAt,
groupIds: $groupIds,
name: $name,
rateLimitTier: $rateLimitTier,
scopes: $scopes,
userId: $userId
) {
apiKey {
...ApiKeyFragment
}
errorDetails
errors
plaintextToken
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"accountId": "4",
"expiresAt": ISO8601DateTime,
"groupIds": ["4"],
"name": "abc123",
"rateLimitTier": "xyz789",
"scopes": ["xyz789"],
"userId": "4"
}
Response
{
"data": {
"createApiKey": {
"apiKey": ApiKey,
"errorDetails": {},
"errors": ["abc123"],
"plaintextToken": "abc123",
"viewer": CurrentUser
}
}
}
createBookingParticipation
Description
Create a booking participation
Response
Returns a CreateBookingParticipationPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation createBookingParticipation($id: ID!) {
createBookingParticipation(id: $id) {
booking {
...BookingFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"createBookingParticipation": {
"booking": Booking,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
}
}
createBookingRequest
Description
Create a booking request
Response
Returns a CreateBookingRequestPayload!
Arguments
| Name | Description |
|---|---|
attributes - BookingRequestAttributes!
|
Example
Query
mutation createBookingRequest($attributes: BookingRequestAttributes!) {
createBookingRequest(attributes: $attributes) {
booking {
...BookingFragment
}
bookingRequest {
...BookingRequestFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": BookingRequestAttributes}
Response
{
"data": {
"createBookingRequest": {
"booking": Booking,
"bookingRequest": BookingRequest,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
}
}
createCohort
Description
Create a cohort
Response
Returns a CreateCohortPayload!
Arguments
| Name | Description |
|---|---|
attributes - CohortAttributes!
|
|
groupId - ID!
|
Example
Query
mutation createCohort(
$attributes: CohortAttributes!,
$groupId: ID!
) {
createCohort(
attributes: $attributes,
groupId: $groupId
) {
cohort {
...CohortFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": CohortAttributes, "groupId": 4}
Response
{
"data": {
"createCohort": {
"cohort": Cohort,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
}
}
createConversation
Description
Create a conversation
Response
Returns a CreateConversationPayload!
Arguments
| Name | Description |
|---|---|
userId - ID!
|
Example
Query
mutation createConversation($userId: ID!) {
createConversation(userId: $userId) {
conversation {
...ConversationFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"userId": 4}
Response
{
"data": {
"createConversation": {
"conversation": Conversation,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
}
}
createConversationFile
Description
Create a conversation file
Response
Returns a CreateConversationFilePayload!
Arguments
| Name | Description |
|---|---|
conversationId - ID!
|
|
file - UploadAttributes
|
|
id - ID!
|
Example
Query
mutation createConversationFile(
$conversationId: ID!,
$file: UploadAttributes,
$id: ID!
) {
createConversationFile(
conversationId: $conversationId,
file: $file,
id: $id
) {
errorDetails
errors
message {
...UploadFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"conversationId": "4",
"file": UploadAttributes,
"id": "4"
}
Response
{
"data": {
"createConversationFile": {
"errorDetails": {},
"errors": ["abc123"],
"message": Upload,
"viewer": CurrentUser
}
}
}
createDiscipline
Description
Create a discipline
Response
Returns a CreateDisciplinePayload!
Arguments
| Name | Description |
|---|---|
attributes - DisciplineAttributes!
|
Example
Query
mutation createDiscipline($attributes: DisciplineAttributes!) {
createDiscipline(attributes: $attributes) {
discipline {
...DisciplineFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": DisciplineAttributes}
Response
{
"data": {
"createDiscipline": {
"discipline": Discipline,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
}
}
createGoalProgressNote
Description
Add a progress note to a goal
Response
Returns a CreateGoalProgressNotePayload!
Example
Query
mutation createGoalProgressNote(
$goalId: ID!,
$noteText: String!
) {
createGoalProgressNote(
goalId: $goalId,
noteText: $noteText
) {
errorDetails
errors
goal {
...UserGoalFragment
}
progressNote {
...GoalProgressNoteFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"goalId": 4, "noteText": "abc123"}
Response
{
"data": {
"createGoalProgressNote": {
"errorDetails": {},
"errors": ["xyz789"],
"goal": UserGoal,
"progressNote": GoalProgressNote,
"viewer": CurrentUser
}
}
}
createGroupConversation
Description
Create a conversation
Response
Returns a CreateGroupConversationPayload!
Example
Query
mutation createGroupConversation(
$isAnnouncement: Boolean,
$memberFilters: MemberFiltersAttributes,
$message: String!,
$recipientIds: [ID!],
$senderId: ID,
$title: String
) {
createGroupConversation(
isAnnouncement: $isAnnouncement,
memberFilters: $memberFilters,
message: $message,
recipientIds: $recipientIds,
senderId: $senderId,
title: $title
) {
conversation {
...ConversationFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"isAnnouncement": false,
"memberFilters": MemberFiltersAttributes,
"message": "abc123",
"recipientIds": [4],
"senderId": 4,
"title": "abc123"
}
Response
{
"data": {
"createGroupConversation": {
"conversation": Conversation,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
}
}
createGroupFile
Description
Create a group file
Response
Returns a CreateGroupFilePayload!
Arguments
| Name | Description |
|---|---|
file - UploadAttributes!
|
|
groupId - ID!
|
|
type - String!
|
Example
Query
mutation createGroupFile(
$file: UploadAttributes!,
$groupId: ID!,
$type: String!
) {
createGroupFile(
file: $file,
groupId: $groupId,
type: $type
) {
errorDetails
errors
groupFile {
...GroupFileFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"file": UploadAttributes,
"groupId": 4,
"type": "abc123"
}
Response
{
"data": {
"createGroupFile": {
"errorDetails": {},
"errors": ["abc123"],
"groupFile": GroupFile,
"viewer": CurrentUser
}
}
}
createGroupMatches
Description
Create a group matches
Response
Returns a CreateGroupMatchesPayload!
Arguments
| Name | Description |
|---|---|
groupId - ID!
|
Example
Query
mutation createGroupMatches($groupId: ID!) {
createGroupMatches(groupId: $groupId) {
errorDetails
errors
status
viewer {
...CurrentUserFragment
}
}
}
Variables
{"groupId": 4}
Response
{
"data": {
"createGroupMatches": {
"errorDetails": {},
"errors": ["abc123"],
"status": "abc123",
"viewer": CurrentUser
}
}
}
createMatch
Description
Create a match
Response
Returns a CreateMatchPayload!
Arguments
| Name | Description |
|---|---|
attributes - MentorMatchAttributes!
|
|
groupId - ID
|
Example
Query
mutation createMatch(
$attributes: MentorMatchAttributes!,
$groupId: ID
) {
createMatch(
attributes: $attributes,
groupId: $groupId
) {
errorDetails
errors
match {
...MentorMatchFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": MentorMatchAttributes, "groupId": 4}
Response
{
"data": {
"createMatch": {
"errorDetails": {},
"errors": ["abc123"],
"match": MentorMatch,
"viewer": CurrentUser
}
}
}
createMatchesFromPreview
Description
Create matches from a preview matching run
Response
Returns a CreateMatchesFromPreviewPayload!
Example
Query
mutation createMatchesFromPreview(
$discardExistingStaged: Boolean,
$matchingRunId: ID!,
$proposedMatches: [JSON!]
) {
createMatchesFromPreview(
discardExistingStaged: $discardExistingStaged,
matchingRunId: $matchingRunId,
proposedMatches: $proposedMatches
) {
errorDetails
errors
matchesCreated
matchingRun {
...MatchingRunFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"discardExistingStaged": false,
"matchingRunId": "4",
"proposedMatches": [{}]
}
Response
{
"data": {
"createMatchesFromPreview": {
"errorDetails": {},
"errors": ["abc123"],
"matchesCreated": 987,
"matchingRun": MatchingRun,
"viewer": CurrentUser
}
}
}
createMessage
Description
Create a message
Response
Returns a CreateMessagePayload!
Example
Query
mutation createMessage(
$conversationId: ID!,
$id: ID!,
$text: String!
) {
createMessage(
conversationId: $conversationId,
id: $id,
text: $text
) {
errorDetails
errors
message {
...MessageFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"conversationId": "4",
"id": 4,
"text": "abc123"
}
Response
{
"data": {
"createMessage": {
"errorDetails": {},
"errors": ["xyz789"],
"message": Message,
"viewer": CurrentUser
}
}
}
createOtpProvisioningUri
Description
Create an otp provisioning uri
Response
Returns a CreateOtpProvisioningUriPayload!
Example
Query
mutation createOtpProvisioningUri {
createOtpProvisioningUri {
errorDetails
errors
otpProvisioningUri
user {
...UserFragment
}
viewer {
...CurrentUserFragment
}
}
}
Response
{
"data": {
"createOtpProvisioningUri": {
"errorDetails": {},
"errors": ["xyz789"],
"otpProvisioningUri": "xyz789",
"user": User,
"viewer": CurrentUser
}
}
}
createReview
Description
Creates a review for the given user
Response
Returns a CreateReviewPayload!
Arguments
| Name | Description |
|---|---|
attributes - ReviewAttributes!
|
Example
Query
mutation createReview($attributes: ReviewAttributes!) {
createReview(attributes: $attributes) {
errorDetails
errors
review {
...ReviewFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": ReviewAttributes}
Response
{
"data": {
"createReview": {
"errorDetails": {},
"errors": ["xyz789"],
"review": Review,
"viewer": CurrentUser
}
}
}
createStripeAccount
Description
Create a stripe account
Response
Returns a CreateStripeAccountPayload!
Arguments
| Name | Description |
|---|---|
attributes - StripeAccountCreateAttributes!
|
Example
Query
mutation createStripeAccount($attributes: StripeAccountCreateAttributes!) {
createStripeAccount(attributes: $attributes) {
account {
...StripeAccountDetailsFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": StripeAccountCreateAttributes}
Response
{
"data": {
"createStripeAccount": {
"account": StripeAccountDetails,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
}
}
createStripeCustomer
Description
Create a stripe customer
Response
Returns a CreateStripeCustomerPayload!
Arguments
| Name | Description |
|---|---|
token - String!
|
Example
Query
mutation createStripeCustomer($token: String!) {
createStripeCustomer(token: $token) {
customer {
...StripeCustomerFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"token": "abc123"}
Response
{
"data": {
"createStripeCustomer": {
"customer": StripeCustomer,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
}
}
createSubdiscipline
Description
Create a subdiscipline
Response
Returns a CreateSubdisciplinePayload!
Arguments
| Name | Description |
|---|---|
attributes - SubdisciplineAttributes!
|
Example
Query
mutation createSubdiscipline($attributes: SubdisciplineAttributes!) {
createSubdiscipline(attributes: $attributes) {
errorDetails
errors
subdiscipline {
...SubdisciplineFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": SubdisciplineAttributes}
Response
{
"data": {
"createSubdiscipline": {
"errorDetails": {},
"errors": ["abc123"],
"subdiscipline": Subdiscipline,
"viewer": CurrentUser
}
}
}
createSurveyQuestion
Description
Create a survey question
Response
Returns a CreateSurveyQuestionPayload!
Arguments
| Name | Description |
|---|---|
attributes - SurveyQuestionAttributes!
|
Example
Query
mutation createSurveyQuestion($attributes: SurveyQuestionAttributes!) {
createSurveyQuestion(attributes: $attributes) {
errorDetails
errors
surveyQuestion {
...SurveyQuestionFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": SurveyQuestionAttributes}
Response
{
"data": {
"createSurveyQuestion": {
"errorDetails": {},
"errors": ["abc123"],
"surveyQuestion": SurveyQuestion,
"viewer": CurrentUser
}
}
}
createSurveyResult
Description
create a survey result for the given or current user
Response
Returns a CreateSurveyResultPayload!
Example
Query
mutation createSurveyResult(
$data: JSON!,
$userId: ID
) {
createSurveyResult(
data: $data,
userId: $userId
) {
errorDetails
errors
user {
...ManagedUserFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"data": {}, "userId": 4}
Response
{
"data": {
"createSurveyResult": {
"errorDetails": {},
"errors": ["abc123"],
"user": ManagedUser,
"viewer": CurrentUser
}
}
}
createTag
Description
Create a tag
Response
Returns a CreateTagPayload!
Arguments
| Name | Description |
|---|---|
attributes - TagAttributes!
|
|
groupId - ID!
|
Example
Query
mutation createTag(
$attributes: TagAttributes!,
$groupId: ID!
) {
createTag(
attributes: $attributes,
groupId: $groupId
) {
errorDetails
errors
tag {
...TagFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"attributes": TagAttributes,
"groupId": "4"
}
Response
{
"data": {
"createTag": {
"errorDetails": {},
"errors": ["abc123"],
"tag": Tag,
"viewer": CurrentUser
}
}
}
createTimeSlot
Description
Create a time slot
Response
Returns a CreateTimeSlotPayload!
Arguments
| Name | Description |
|---|---|
attributes - TimeSlotAttributes!
|
|
userId - ID
|
Example
Query
mutation createTimeSlot(
$attributes: TimeSlotAttributes!,
$userId: ID
) {
createTimeSlot(
attributes: $attributes,
userId: $userId
) {
errorDetails
errors
timeSlot {
...TimeSlotFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": TimeSlotAttributes, "userId": 4}
Response
{
"data": {
"createTimeSlot": {
"errorDetails": {},
"errors": ["xyz789"],
"timeSlot": TimeSlot,
"viewer": CurrentUser
}
}
}
createUser
Description
Create a user
Response
Returns a CreateUserPayload!
Arguments
| Name | Description |
|---|---|
attributes - UserAttributes!
|
|
groupId - ID!
|
Example
Query
mutation createUser(
$attributes: UserAttributes!,
$groupId: ID!
) {
createUser(
attributes: $attributes,
groupId: $groupId
) {
errorDetails
errors
user {
...ManagedUserFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": UserAttributes, "groupId": 4}
Response
{
"data": {
"createUser": {
"errorDetails": {},
"errors": ["xyz789"],
"user": ManagedUser,
"viewer": CurrentUser
}
}
}
createUserFile
Description
Create a user file
Response
Returns a CreateUserFilePayload!
Arguments
| Name | Description |
|---|---|
file - UploadAttributes!
|
|
userId - ID!
|
Example
Query
mutation createUserFile(
$file: UploadAttributes!,
$userId: ID!
) {
createUserFile(
file: $file,
userId: $userId
) {
errorDetails
errors
userFile {
...UserFileFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"file": UploadAttributes, "userId": 4}
Response
{
"data": {
"createUserFile": {
"errorDetails": {},
"errors": ["abc123"],
"userFile": UserFile,
"viewer": CurrentUser
}
}
}
createUserGoal
Description
Create a new user goal
Response
Returns a CreateUserGoalPayload!
Example
Query
mutation createUserGoal(
$goalText: String!,
$userId: ID
) {
createUserGoal(
goalText: $goalText,
userId: $userId
) {
errorDetails
errors
goal {
...UserGoalFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"goalText": "xyz789", "userId": 4}
Response
{
"data": {
"createUserGoal": {
"errorDetails": {},
"errors": ["abc123"],
"goal": UserGoal,
"viewer": CurrentUser
}
}
}
deactivateMatches
Description
Deactivate given matches
Response
Returns a DeactivateMatchesPayload!
Arguments
| Name | Description |
|---|---|
ids - [ID!]!
|
Example
Query
mutation deactivateMatches($ids: [ID!]!) {
deactivateMatches(ids: $ids) {
errorDetails
errors
updatedRecordCount
viewer {
...CurrentUserFragment
}
}
}
Variables
{"ids": [4]}
Response
{
"data": {
"deactivateMatches": {
"errorDetails": {},
"errors": ["xyz789"],
"updatedRecordCount": 987,
"viewer": CurrentUser
}
}
}
deleteAllGroupFiles
Description
Delete an all group files
Response
Returns a DeleteAllGroupFilesPayload!
Example
Query
mutation deleteAllGroupFiles(
$id: ID!,
$type: String!
) {
deleteAllGroupFiles(
id: $id,
type: $type
) {
errorDetails
errors
groupFiles {
...GroupFileFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4, "type": "abc123"}
Response
{
"data": {
"deleteAllGroupFiles": {
"errorDetails": {},
"errors": ["xyz789"],
"groupFiles": [GroupFile],
"viewer": CurrentUser
}
}
}
deleteAllUserFiles
Description
Delete an all user files
Response
Returns a DeleteAllUserFilesPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteAllUserFiles($id: ID!) {
deleteAllUserFiles(id: $id) {
errorDetails
errors
userFiles {
...UserFileFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteAllUserFiles": {
"errorDetails": {},
"errors": ["abc123"],
"userFiles": [UserFile],
"viewer": CurrentUser
}
}
}
deleteBookingParticipation
Description
Delete a booking participation
Response
Returns a DeleteBookingParticipationPayload!
Example
Query
mutation deleteBookingParticipation(
$id: ID!,
$reason: String!
) {
deleteBookingParticipation(
id: $id,
reason: $reason
) {
booking {
...BookingFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"id": "4",
"reason": "xyz789"
}
Response
{
"data": {
"deleteBookingParticipation": {
"booking": Booking,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
}
}
deleteConnection
Description
Delete a connection
Response
Returns a DeleteConnectionPayload!
Arguments
| Name | Description |
|---|---|
type - SocialConnection!
|
Example
Query
mutation deleteConnection($type: SocialConnection!) {
deleteConnection(type: $type) {
errorDetails
errors
user {
...ManagedUserFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"type": "google"}
Response
{
"data": {
"deleteConnection": {
"errorDetails": {},
"errors": ["abc123"],
"user": ManagedUser,
"viewer": CurrentUser
}
}
}
deleteDiscipline
Description
Delete a discipline
Response
Returns a DeleteDisciplinePayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteDiscipline($id: ID!) {
deleteDiscipline(id: $id) {
discipline {
...DisciplineFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteDiscipline": {
"discipline": Discipline,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
}
}
deleteGoalProgressNote
Description
Delete a progress note
Response
Returns a DeleteGoalProgressNotePayload!
Arguments
| Name | Description |
|---|---|
noteId - ID!
|
Example
Query
mutation deleteGoalProgressNote($noteId: ID!) {
deleteGoalProgressNote(noteId: $noteId) {
errorDetails
errors
goal {
...UserGoalFragment
}
success
viewer {
...CurrentUserFragment
}
}
}
Variables
{"noteId": 4}
Response
{
"data": {
"deleteGoalProgressNote": {
"errorDetails": {},
"errors": ["abc123"],
"goal": UserGoal,
"success": true,
"viewer": CurrentUser
}
}
}
deleteGroupFile
Description
Delete a group file
Response
Returns a DeleteGroupFilePayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteGroupFile($id: ID!) {
deleteGroupFile(id: $id) {
errorDetails
errors
groupFile {
...GroupFileFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteGroupFile": {
"errorDetails": {},
"errors": ["abc123"],
"groupFile": GroupFile,
"viewer": CurrentUser
}
}
}
deleteGroupUsers
Description
Delete a group users
Response
Returns a DeleteGroupUsersPayload!
Arguments
| Name | Description |
|---|---|
ids - [ID!]
|
|
memberFilters - MemberFiltersAttributes
|
Example
Query
mutation deleteGroupUsers(
$ids: [ID!],
$memberFilters: MemberFiltersAttributes
) {
deleteGroupUsers(
ids: $ids,
memberFilters: $memberFilters
) {
deletedUsersCount
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"ids": ["4"],
"memberFilters": MemberFiltersAttributes
}
Response
{
"data": {
"deleteGroupUsers": {
"deletedUsersCount": 123,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
}
}
deleteMatch
Description
Delete a match
Response
Returns a DeleteMatchPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteMatch($id: ID!) {
deleteMatch(id: $id) {
errorDetails
errors
match {
...MentorMatchFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteMatch": {
"errorDetails": {},
"errors": ["xyz789"],
"match": MentorMatch,
"viewer": CurrentUser
}
}
}
deleteStripeAccount
Description
Delete a stripe account
Response
Returns a DeleteStripeAccountPayload!
Example
Query
mutation deleteStripeAccount {
deleteStripeAccount {
account {
...StripeAccountDetailsFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Response
{
"data": {
"deleteStripeAccount": {
"account": StripeAccountDetails,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
}
}
deleteStripeCustomer
Description
Delete a stripe customer
Response
Returns a DeleteStripeCustomerPayload!
Example
Query
mutation deleteStripeCustomer {
deleteStripeCustomer {
customer {
...StripeCustomerFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Response
{
"data": {
"deleteStripeCustomer": {
"customer": StripeCustomer,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
}
}
deleteSubdiscipline
Description
Delete a subdiscipline
Response
Returns a DeleteSubdisciplinePayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteSubdiscipline($id: ID!) {
deleteSubdiscipline(id: $id) {
errorDetails
errors
subdiscipline {
...SubdisciplineFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteSubdiscipline": {
"errorDetails": {},
"errors": ["abc123"],
"subdiscipline": Subdiscipline,
"viewer": CurrentUser
}
}
}
deleteSurveyQuestion
Description
Delete a survey question
Response
Returns a DeleteSurveyQuestionPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteSurveyQuestion($id: ID!) {
deleteSurveyQuestion(id: $id) {
errorDetails
errors
surveyQuestion {
...SurveyQuestionFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteSurveyQuestion": {
"errorDetails": {},
"errors": ["abc123"],
"surveyQuestion": SurveyQuestion,
"viewer": CurrentUser
}
}
}
deleteTag
Description
Delete a tag
Response
Returns a DeleteTagPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteTag($id: ID!) {
deleteTag(id: $id) {
errorDetails
errors
tag {
...TagFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteTag": {
"errorDetails": {},
"errors": ["abc123"],
"tag": Tag,
"viewer": CurrentUser
}
}
}
deleteTimeSlot
Description
Delete a time slot
Response
Returns a DeleteTimeSlotPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
occurrenceDate - ISO8601DateTime
|
Example
Query
mutation deleteTimeSlot(
$id: ID!,
$occurrenceDate: ISO8601DateTime
) {
deleteTimeSlot(
id: $id,
occurrenceDate: $occurrenceDate
) {
errorDetails
errors
timeSlot {
...TimeSlotFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4, "occurrenceDate": ISO8601DateTime}
Response
{
"data": {
"deleteTimeSlot": {
"errorDetails": {},
"errors": ["xyz789"],
"timeSlot": TimeSlot,
"viewer": CurrentUser
}
}
}
deleteUser
Description
Delete a user
Response
Returns a DeleteUserPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteUser($id: ID!) {
deleteUser(id: $id) {
errorDetails
errors
user {
...ManagedUserFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteUser": {
"errorDetails": {},
"errors": ["xyz789"],
"user": ManagedUser,
"viewer": CurrentUser
}
}
}
deleteUserFile
Description
Delete a user file
Response
Returns a DeleteUserFilePayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteUserFile($id: ID!) {
deleteUserFile(id: $id) {
errorDetails
errors
userFile {
...UserFileFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteUserFile": {
"errorDetails": {},
"errors": ["abc123"],
"userFile": UserFile,
"viewer": CurrentUser
}
}
}
deleteUserGoal
Description
Soft delete a user goal
Response
Returns a DeleteUserGoalPayload!
Arguments
| Name | Description |
|---|---|
goalId - ID!
|
Example
Query
mutation deleteUserGoal($goalId: ID!) {
deleteUserGoal(goalId: $goalId) {
errorDetails
errors
goal {
...UserGoalFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"goalId": "4"}
Response
{
"data": {
"deleteUserGoal": {
"errorDetails": {},
"errors": ["abc123"],
"goal": UserGoal,
"viewer": CurrentUser
}
}
}
disconnectCalendarAccount
Description
Remove a connected Cronofy profile (calendar account) from the user. Mirrors Settings::ConnectionsController#destroy: revoke via Cronofy and also clear calendar_id + conferencing_provider on the user so no stale references remain.
Response
Returns a DisconnectCalendarAccountPayload!
Arguments
| Name | Description |
|---|---|
profileId - String!
|
Cronofy profile id (e.g. 'pro_abc123') |
Example
Query
mutation disconnectCalendarAccount($profileId: String!) {
disconnectCalendarAccount(profileId: $profileId) {
calendarConnection {
...CalendarConnectionFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"profileId": "xyz789"}
Response
{
"data": {
"disconnectCalendarAccount": {
"calendarConnection": CalendarConnection,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
}
}
disconnectSlack
Description
Soft-disconnect the current user from Slack. Sets the SlackUserMapping to inactive so notifications fall back to email until they reconnect.
Response
Returns a DisconnectSlackPayload!
Example
Query
mutation disconnectSlack {
disconnectSlack {
errorDetails
errors
slackConnection {
...SlackConnectionFragment
}
viewer {
...CurrentUserFragment
}
}
}
Response
{
"data": {
"disconnectSlack": {
"errorDetails": {},
"errors": ["xyz789"],
"slackConnection": SlackConnection,
"viewer": CurrentUser
}
}
}
extendBooking
Description
Extend a booking
Response
Returns an ExtendBookingPayload!
Example
Query
mutation extendBooking(
$id: ID!,
$minutes: Int
) {
extendBooking(
id: $id,
minutes: $minutes
) {
booking {
...BookingFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": "4", "minutes": 123}
Response
{
"data": {
"extendBooking": {
"booking": Booking,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
}
}
importCsvFile
Description
Imports a CSV file
Response
Returns an ImportCSVFilePayload!
Arguments
| Name | Description |
|---|---|
file - UploadAttributes!
|
|
groupId - ID!
|
Example
Query
mutation importCsvFile(
$file: UploadAttributes!,
$groupId: ID!
) {
importCsvFile(
file: $file,
groupId: $groupId
) {
errorDetails
errors
groupFile {
...GroupFileFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"file": UploadAttributes, "groupId": 4}
Response
{
"data": {
"importCsvFile": {
"errorDetails": {},
"errors": ["xyz789"],
"groupFile": GroupFile,
"viewer": CurrentUser
}
}
}
initiateCalendarConnect
Description
Returns the Cronofy authorization URL for a given provider. The frontend should redirect the browser there to start the OAuth flow. Cronofy redirects back to /auth/cronofy/callback when the user finishes.
Response
Returns an InitiateCalendarConnectPayload!
Arguments
| Name | Description |
|---|---|
provider - String!
|
Provider slug — e.g. 'google_calendar', 'office365', 'apple', 'icloud' |
Example
Query
mutation initiateCalendarConnect($provider: String!) {
initiateCalendarConnect(provider: $provider) {
errorDetails
errors
redirectUrl
viewer {
...CurrentUserFragment
}
}
}
Variables
{"provider": "xyz789"}
Response
{
"data": {
"initiateCalendarConnect": {
"errorDetails": {},
"errors": ["abc123"],
"redirectUrl": "xyz789",
"viewer": CurrentUser
}
}
}
initiateSlackOauth
Description
Returns the URL the frontend should redirect the browser to in order to start the Slack OAuth install flow. The URL points at the Rails install endpoint, which signs the state and redirects on to slack.com/oauth/v2/authorize. Slack is installed at the account level — every program in the account inherits.
Response
Returns an InitiateSlackOauthPayload!
Example
Query
mutation initiateSlackOauth {
initiateSlackOauth {
errorDetails
errors
redirectUrl
viewer {
...CurrentUserFragment
}
}
}
Response
{
"data": {
"initiateSlackOauth": {
"errorDetails": {},
"errors": ["xyz789"],
"redirectUrl": "abc123",
"viewer": CurrentUser
}
}
}
moveGroupFileHigher
Description
Move a group file higher
Response
Returns a MoveGroupFileHigherPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation moveGroupFileHigher($id: ID!) {
moveGroupFileHigher(id: $id) {
errorDetails
errors
groupFile {
...GroupFileFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"moveGroupFileHigher": {
"errorDetails": {},
"errors": ["abc123"],
"groupFile": GroupFile,
"viewer": CurrentUser
}
}
}
moveGroupFileLower
Description
Move a group file lower
Response
Returns a MoveGroupFileLowerPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation moveGroupFileLower($id: ID!) {
moveGroupFileLower(id: $id) {
errorDetails
errors
groupFile {
...GroupFileFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"moveGroupFileLower": {
"errorDetails": {},
"errors": ["xyz789"],
"groupFile": GroupFile,
"viewer": CurrentUser
}
}
}
moveUserFileHigher
Description
Move a user file higher
Response
Returns a MoveUserFileHigherPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation moveUserFileHigher($id: ID!) {
moveUserFileHigher(id: $id) {
errorDetails
errors
userFile {
...UserFileFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"moveUserFileHigher": {
"errorDetails": {},
"errors": ["abc123"],
"userFile": UserFile,
"viewer": CurrentUser
}
}
}
moveUserFileLower
Description
Move a user file lower
Response
Returns a MoveUserFileLowerPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation moveUserFileLower($id: ID!) {
moveUserFileLower(id: $id) {
errorDetails
errors
userFile {
...UserFileFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"moveUserFileLower": {
"errorDetails": {},
"errors": ["abc123"],
"userFile": UserFile,
"viewer": CurrentUser
}
}
}
previewMatching
Description
Preview matching results without creating matches
Response
Returns a PreviewMatchingPayload!
Example
Query
mutation previewMatching(
$groupId: ID!,
$menteeFilters: JSON,
$menteeSlots: Int!,
$menteesWithCapacityOnly: Boolean,
$mentorFilters: JSON,
$mentorSlots: Int!,
$mentorsWithCapacityOnly: Boolean,
$unmatchedMenteesOnly: Boolean
) {
previewMatching(
groupId: $groupId,
menteeFilters: $menteeFilters,
menteeSlots: $menteeSlots,
menteesWithCapacityOnly: $menteesWithCapacityOnly,
mentorFilters: $mentorFilters,
mentorSlots: $mentorSlots,
mentorsWithCapacityOnly: $mentorsWithCapacityOnly,
unmatchedMenteesOnly: $unmatchedMenteesOnly
) {
averageScore
errorDetails
errors
matchingRunId
menteeCount
mentorCount
proposedMatches {
...ProposedMatchFragment
}
viewer {
...CurrentUserFragment
}
warnings
}
}
Variables
{
"groupId": 4,
"menteeFilters": {},
"menteeSlots": 123,
"menteesWithCapacityOnly": false,
"mentorFilters": {},
"mentorSlots": 123,
"mentorsWithCapacityOnly": false,
"unmatchedMenteesOnly": false
}
Response
{
"data": {
"previewMatching": {
"averageScore": 123.45,
"errorDetails": {},
"errors": ["xyz789"],
"matchingRunId": "4",
"menteeCount": 123,
"mentorCount": 987,
"proposedMatches": [ProposedMatch],
"viewer": CurrentUser,
"warnings": ["abc123"]
}
}
}
registerAccountUser
Description
Register a new account user
Response
Returns a RegisterAccountUserPayload!
Example
Query
mutation registerAccountUser(
$email: String!,
$locale: String,
$name: String!,
$password: String!
) {
registerAccountUser(
email: $email,
locale: $locale,
name: $name,
password: $password
) {
errorDetails
errors
loginUrl
user {
...CurrentUserFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"email": "xyz789",
"locale": "xyz789",
"name": "xyz789",
"password": "abc123"
}
Response
{
"data": {
"registerAccountUser": {
"errorDetails": {},
"errors": ["xyz789"],
"loginUrl": "abc123",
"user": CurrentUser,
"viewer": CurrentUser
}
}
}
registerUser
Description
Register a new user
Response
Returns a RegisterUserPayload!
Example
Query
mutation registerUser(
$email: String!,
$groupId: ID!,
$locale: String,
$mentor: Boolean,
$name: String!,
$password: String!
) {
registerUser(
email: $email,
groupId: $groupId,
locale: $locale,
mentor: $mentor,
name: $name,
password: $password
) {
errorDetails
errors
loginUrl
user {
...CurrentUserFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"email": "xyz789",
"groupId": 4,
"locale": "xyz789",
"mentor": true,
"name": "abc123",
"password": "xyz789"
}
Response
{
"data": {
"registerUser": {
"errorDetails": {},
"errors": ["abc123"],
"loginUrl": "xyz789",
"user": CurrentUser,
"viewer": CurrentUser
}
}
}
rejectBookingRequest
Description
Reject a booking request
Response
Returns a RejectBookingRequestPayload!
Example
Query
mutation rejectBookingRequest(
$id: ID!,
$reason: String!
) {
rejectBookingRequest(
id: $id,
reason: $reason
) {
bookingRequest {
...BookingRequestFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"id": "4",
"reason": "xyz789"
}
Response
{
"data": {
"rejectBookingRequest": {
"bookingRequest": BookingRequest,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
}
}
removeAuthenticator
Description
Remove an authenticator
Response
Returns a RemoveAuthenticatorPayload!
Example
Query
mutation removeAuthenticator {
removeAuthenticator {
errorDetails
errors
user {
...CurrentUserFragment
}
viewer {
...CurrentUserFragment
}
}
}
Response
{
"data": {
"removeAuthenticator": {
"errorDetails": {},
"errors": ["abc123"],
"user": CurrentUser,
"viewer": CurrentUser
}
}
}
removeZoomConnection
Description
Remove a zoom connection
Response
Returns a RemoveZoomConnectionPayload!
Example
Query
mutation removeZoomConnection {
removeZoomConnection {
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Response
{
"data": {
"removeZoomConnection": {
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
}
}
requestPasswordReset
Description
Request a password reset
Response
Returns a RequestPasswordResetPayload!
Example
Query
mutation requestPasswordReset(
$email: String,
$groupId: ID,
$id: ID
) {
requestPasswordReset(
email: $email,
groupId: $groupId,
id: $id
) {
errorDetails
errors
status
viewer {
...CurrentUserFragment
}
}
}
Variables
{"email": "abc123", "groupId": 4, "id": 4}
Response
{
"data": {
"requestPasswordReset": {
"errorDetails": {},
"errors": ["abc123"],
"status": "abc123",
"viewer": CurrentUser
}
}
}
resetPassword
Description
Reset a password
Response
Returns a ResetPasswordPayload!
Example
Query
mutation resetPassword(
$email: String!,
$groupId: ID,
$password: String!,
$token: ID!
) {
resetPassword(
email: $email,
groupId: $groupId,
password: $password,
token: $token
) {
errorDetails
errors
user {
...CurrentUserFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"email": "xyz789",
"groupId": "4",
"password": "abc123",
"token": "4"
}
Response
{
"data": {
"resetPassword": {
"errorDetails": {},
"errors": ["xyz789"],
"user": CurrentUser,
"viewer": CurrentUser
}
}
}
revokeApiKey
Description
Revoke (deactivate) an API key (admin only)
Response
Returns a RevokeApiKeyPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation revokeApiKey($id: ID!) {
revokeApiKey(id: $id) {
apiKey {
...ApiKeyFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"revokeApiKey": {
"apiKey": ApiKey,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
}
}
rotateApiKey
Description
Rotate an API key: deactivate the old, create a new one with the same config (admin only)
Response
Returns a RotateApiKeyPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation rotateApiKey($id: ID!) {
rotateApiKey(id: $id) {
apiKey {
...ApiKeyFragment
}
errorDetails
errors
plaintextToken
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"rotateApiKey": {
"apiKey": ApiKey,
"errorDetails": {},
"errors": ["abc123"],
"plaintextToken": "xyz789",
"viewer": CurrentUser
}
}
}
runAutomaticMatching
Description
Run automatic matching
Response
Returns a RunAutomaticMatchingPayload!
Example
Query
mutation runAutomaticMatching(
$groupId: ID!,
$menteeSlots: Int!,
$mentorSlots: Int!
) {
runAutomaticMatching(
groupId: $groupId,
menteeSlots: $menteeSlots,
mentorSlots: $mentorSlots
) {
errorDetails
errors
status {
...JobStatusFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"groupId": "4",
"menteeSlots": 987,
"mentorSlots": 123
}
Response
{
"data": {
"runAutomaticMatching": {
"errorDetails": {},
"errors": ["xyz789"],
"status": JobStatus,
"viewer": CurrentUser
}
}
}
sendOnboardingEmail
Description
Send an onboarding email
Response
Returns a SendOnboardingEmailPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation sendOnboardingEmail($id: ID!) {
sendOnboardingEmail(id: $id) {
errorDetails
errors
status
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"sendOnboardingEmail": {
"errorDetails": {},
"errors": ["xyz789"],
"status": "abc123",
"viewer": CurrentUser
}
}
}
sendPasswordResetEmail
Description
Request a password reset
Response
Returns a RequestPasswordResetPayload!
Example
Query
mutation sendPasswordResetEmail(
$email: String,
$groupId: ID,
$id: ID
) {
sendPasswordResetEmail(
email: $email,
groupId: $groupId,
id: $id
) {
errorDetails
errors
status
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"email": "xyz789",
"groupId": 4,
"id": "4"
}
Response
{
"data": {
"sendPasswordResetEmail": {
"errorDetails": {},
"errors": ["abc123"],
"status": "abc123",
"viewer": CurrentUser
}
}
}
sendPendingInvitationEmails
Description
Send a pending invitation emails
Response
Returns a SendPendingInvitationEmailsPayload!
Arguments
| Name | Description |
|---|---|
groupId - ID!
|
Example
Query
mutation sendPendingInvitationEmails($groupId: ID!) {
sendPendingInvitationEmails(groupId: $groupId) {
errorDetails
errors
status
viewer {
...CurrentUserFragment
}
}
}
Variables
{"groupId": 4}
Response
{
"data": {
"sendPendingInvitationEmails": {
"errorDetails": {},
"errors": ["xyz789"],
"status": "xyz789",
"viewer": CurrentUser
}
}
}
stageMatches
Description
Stage matches with the given ids
Response
Returns a StageMatchesPayload!
Example
Query
mutation stageMatches(
$ids: [ID!]!,
$manual: Boolean
) {
stageMatches(
ids: $ids,
manual: $manual
) {
errorDetails
errors
updatedRecordCount
viewer {
...CurrentUserFragment
}
}
}
Variables
{"ids": ["4"], "manual": true}
Response
{
"data": {
"stageMatches": {
"errorDetails": {},
"errors": ["abc123"],
"updatedRecordCount": 987,
"viewer": CurrentUser
}
}
}
unarchiveGroupUsers
Description
Unarchive a group users
Response
Returns an UnarchiveGroupUsersPayload!
Arguments
| Name | Description |
|---|---|
ids - [ID!]
|
|
memberFilters - MemberFiltersAttributes
|
Example
Query
mutation unarchiveGroupUsers(
$ids: [ID!],
$memberFilters: MemberFiltersAttributes
) {
unarchiveGroupUsers(
ids: $ids,
memberFilters: $memberFilters
) {
errorDetails
errors
unarchivedUsersCount
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"ids": ["4"],
"memberFilters": MemberFiltersAttributes
}
Response
{
"data": {
"unarchiveGroupUsers": {
"errorDetails": {},
"errors": ["abc123"],
"unarchivedUsersCount": 123,
"viewer": CurrentUser
}
}
}
unarchiveUser
Description
Unarchive a user
Response
Returns an UnarchiveUserPayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation unarchiveUser($id: ID!) {
unarchiveUser(id: $id) {
errorDetails
errors
user {
...ManagedUserFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"unarchiveUser": {
"errorDetails": {},
"errors": ["abc123"],
"user": ManagedUser,
"viewer": CurrentUser
}
}
}
uncompleteUserGoal
Description
Mark a completed goal as uncompleted
Response
Returns an UncompleteUserGoalPayload!
Arguments
| Name | Description |
|---|---|
goalId - ID!
|
Example
Query
mutation uncompleteUserGoal($goalId: ID!) {
uncompleteUserGoal(goalId: $goalId) {
errorDetails
errors
goal {
...UserGoalFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"goalId": "4"}
Response
{
"data": {
"uncompleteUserGoal": {
"errorDetails": {},
"errors": ["xyz789"],
"goal": UserGoal,
"viewer": CurrentUser
}
}
}
updateBooking
Description
Update a booking
Response
Returns an UpdateBookingPayload!
Arguments
| Name | Description |
|---|---|
attributes - BookingAttributes!
|
|
id - ID!
|
Example
Query
mutation updateBooking(
$attributes: BookingAttributes!,
$id: ID!
) {
updateBooking(
attributes: $attributes,
id: $id
) {
booking {
...BookingFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": BookingAttributes, "id": 4}
Response
{
"data": {
"updateBooking": {
"booking": Booking,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
}
}
updateCalendarConfiguration
Description
Set the user's selected sync calendar and/or conferencing provider. Mirrors Settings::ConnectionsController#configure.
Response
Returns an UpdateCalendarConfigurationPayload!
Example
Query
mutation updateCalendarConfiguration(
$calendarId: String,
$conferencingProvider: String
) {
updateCalendarConfiguration(
calendarId: $calendarId,
conferencingProvider: $conferencingProvider
) {
calendarConnection {
...CalendarConnectionFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"calendarId": "abc123",
"conferencingProvider": "abc123"
}
Response
{
"data": {
"updateCalendarConfiguration": {
"calendarConnection": CalendarConnection,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
}
}
updateCohort
Description
Update a cohort
Response
Returns an UpdateCohortPayload!
Arguments
| Name | Description |
|---|---|
attributes - CohortAttributes!
|
|
id - ID!
|
Example
Query
mutation updateCohort(
$attributes: CohortAttributes!,
$id: ID!
) {
updateCohort(
attributes: $attributes,
id: $id
) {
cohort {
...CohortFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"attributes": CohortAttributes,
"id": "4"
}
Response
{
"data": {
"updateCohort": {
"cohort": Cohort,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
}
}
updateConversationTitle
Description
Update a conversation title
Response
Returns an UpdateConversationTitlePayload!
Example
Query
mutation updateConversationTitle(
$id: ID!,
$title: String!
) {
updateConversationTitle(
id: $id,
title: $title
) {
conversation {
...ConversationFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"id": "4",
"title": "xyz789"
}
Response
{
"data": {
"updateConversationTitle": {
"conversation": Conversation,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
}
}
updateDiscipline
Description
Update a discipline
Response
Returns an UpdateDisciplinePayload!
Arguments
| Name | Description |
|---|---|
attributes - DisciplineAttributes!
|
|
id - ID!
|
Example
Query
mutation updateDiscipline(
$attributes: DisciplineAttributes!,
$id: ID!
) {
updateDiscipline(
attributes: $attributes,
id: $id
) {
discipline {
...DisciplineFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": DisciplineAttributes, "id": 4}
Response
{
"data": {
"updateDiscipline": {
"discipline": Discipline,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
}
}
updateGoalProgressNote
Description
Update an existing progress note
Response
Returns an UpdateGoalProgressNotePayload!
Example
Query
mutation updateGoalProgressNote(
$noteId: ID!,
$noteText: String!
) {
updateGoalProgressNote(
noteId: $noteId,
noteText: $noteText
) {
errorDetails
errors
goal {
...UserGoalFragment
}
progressNote {
...GoalProgressNoteFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"noteId": "4",
"noteText": "xyz789"
}
Response
{
"data": {
"updateGoalProgressNote": {
"errorDetails": {},
"errors": ["abc123"],
"goal": UserGoal,
"progressNote": GoalProgressNote,
"viewer": CurrentUser
}
}
}
updateGroup
Description
Update a group
Response
Returns an UpdateGroupPayload!
Arguments
| Name | Description |
|---|---|
attributes - GroupAttributes!
|
|
id - ID!
|
Example
Query
mutation updateGroup(
$attributes: GroupAttributes!,
$id: ID!
) {
updateGroup(
attributes: $attributes,
id: $id
) {
errorDetails
errors
managedGroup {
...ManagedGroupFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": GroupAttributes, "id": 4}
Response
{
"data": {
"updateGroup": {
"errorDetails": {},
"errors": ["xyz789"],
"managedGroup": ManagedGroup,
"viewer": CurrentUser
}
}
}
updateGroupFile
Description
Update a group file
Response
Returns an UpdateGroupFilePayload!
Arguments
| Name | Description |
|---|---|
file - UploadAttributes
|
|
id - ID!
|
|
url - String
|
Example
Query
mutation updateGroupFile(
$file: UploadAttributes,
$id: ID!,
$url: String
) {
updateGroupFile(
file: $file,
id: $id,
url: $url
) {
errorDetails
errors
groupFile {
...GroupFileFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"file": UploadAttributes,
"id": 4,
"url": "xyz789"
}
Response
{
"data": {
"updateGroupFile": {
"errorDetails": {},
"errors": ["abc123"],
"groupFile": GroupFile,
"viewer": CurrentUser
}
}
}
updateGroupPaymentSettings
Description
Update payment settings for the group
Response
Returns an UpdateGroupPaymentSettingsPayload!
Arguments
| Name | Description |
|---|---|
attributes - GroupPaymentSettingsAttributes!
|
|
id - ID!
|
Example
Query
mutation updateGroupPaymentSettings(
$attributes: GroupPaymentSettingsAttributes!,
$id: ID!
) {
updateGroupPaymentSettings(
attributes: $attributes,
id: $id
) {
errorDetails
errors
managedGroup {
...ManagedGroupFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": GroupPaymentSettingsAttributes, "id": 4}
Response
{
"data": {
"updateGroupPaymentSettings": {
"errorDetails": {},
"errors": ["xyz789"],
"managedGroup": ManagedGroup,
"viewer": CurrentUser
}
}
}
updateGroupStyles
Description
Update a group styles
Response
Returns an UpdateGroupStylesPayload!
Arguments
| Name | Description |
|---|---|
attributes - GroupStylesAttributes!
|
|
id - ID!
|
Example
Query
mutation updateGroupStyles(
$attributes: GroupStylesAttributes!,
$id: ID!
) {
updateGroupStyles(
attributes: $attributes,
id: $id
) {
errorDetails
errors
managedGroup {
...ManagedGroupFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": GroupStylesAttributes, "id": 4}
Response
{
"data": {
"updateGroupStyles": {
"errorDetails": {},
"errors": ["xyz789"],
"managedGroup": ManagedGroup,
"viewer": CurrentUser
}
}
}
updateGroupUsers
Description
Update a group users
Response
Returns an UpdateGroupUsersPayload!
Arguments
| Name | Description |
|---|---|
attributes - UserAttributes!
|
|
ids - [ID!]
|
|
memberFilters - MemberFiltersAttributes
|
Example
Query
mutation updateGroupUsers(
$attributes: UserAttributes!,
$ids: [ID!],
$memberFilters: MemberFiltersAttributes
) {
updateGroupUsers(
attributes: $attributes,
ids: $ids,
memberFilters: $memberFilters
) {
errorDetails
errors
updatedUsersCount
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"attributes": UserAttributes,
"ids": ["4"],
"memberFilters": MemberFiltersAttributes
}
Response
{
"data": {
"updateGroupUsers": {
"errorDetails": {},
"errors": ["abc123"],
"updatedUsersCount": 123,
"viewer": CurrentUser
}
}
}
updateMatch
Description
Update a match
Response
Returns an UpdateMatchPayload!
Arguments
| Name | Description |
|---|---|
attributes - MentorMatchAttributes!
|
|
id - ID!
|
Example
Query
mutation updateMatch(
$attributes: MentorMatchAttributes!,
$id: ID!
) {
updateMatch(
attributes: $attributes,
id: $id
) {
errorDetails
errors
match {
...MentorMatchFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"attributes": MentorMatchAttributes,
"id": "4"
}
Response
{
"data": {
"updateMatch": {
"errorDetails": {},
"errors": ["abc123"],
"match": MentorMatch,
"viewer": CurrentUser
}
}
}
updateOnboardingConfig
Description
Update the onboarding builder configuration for a group
Response
Returns an UpdateOnboardingConfigPayload!
Arguments
| Name | Description |
|---|---|
groupId - ID!
|
The group to update |
step1Fields - [OnboardingFieldInput!]!
|
Fields for Step 1 (Profile & Questions) |
step2Fields - [OnboardingFieldInput!]!
|
Fields for Step 2 (Goals & Matching) |
Example
Query
mutation updateOnboardingConfig(
$groupId: ID!,
$step1Fields: [OnboardingFieldInput!]!,
$step2Fields: [OnboardingFieldInput!]!
) {
updateOnboardingConfig(
groupId: $groupId,
step1Fields: $step1Fields,
step2Fields: $step2Fields
) {
errorDetails
errors
onboardingConfig {
...OnboardingConfigFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"groupId": "4",
"step1Fields": [OnboardingFieldInput],
"step2Fields": [OnboardingFieldInput]
}
Response
{
"data": {
"updateOnboardingConfig": {
"errorDetails": {},
"errors": ["xyz789"],
"onboardingConfig": OnboardingConfig,
"viewer": CurrentUser
}
}
}
updatePassword
Description
Reset a password
Response
Returns a ResetPasswordPayload!
Example
Query
mutation updatePassword(
$email: String!,
$groupId: ID,
$password: String!,
$token: ID!
) {
updatePassword(
email: $email,
groupId: $groupId,
password: $password,
token: $token
) {
errorDetails
errors
user {
...CurrentUserFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"email": "abc123",
"groupId": 4,
"password": "abc123",
"token": 4
}
Response
{
"data": {
"updatePassword": {
"errorDetails": {},
"errors": ["xyz789"],
"user": CurrentUser,
"viewer": CurrentUser
}
}
}
updatePasswordWithPassword
Description
Update a password
Response
Returns an UpdatePasswordPayload!
Example
Query
mutation updatePasswordWithPassword(
$existingPassword: String!,
$password: String!
) {
updatePasswordWithPassword(
existingPassword: $existingPassword,
password: $password
) {
errorDetails
errors
user {
...CurrentUserFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"existingPassword": "abc123",
"password": "xyz789"
}
Response
{
"data": {
"updatePasswordWithPassword": {
"errorDetails": {},
"errors": ["xyz789"],
"user": CurrentUser,
"viewer": CurrentUser
}
}
}
updateSlackNotificationPreference
Description
Switch the current user's notification routing between Slack DM and email.
Response
Returns an UpdateSlackNotificationPreferencePayload!
Arguments
| Name | Description |
|---|---|
preference - String!
|
One of: slack, email |
Example
Query
mutation updateSlackNotificationPreference($preference: String!) {
updateSlackNotificationPreference(preference: $preference) {
errorDetails
errors
slackConnection {
...SlackConnectionFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"preference": "xyz789"}
Response
{
"data": {
"updateSlackNotificationPreference": {
"errorDetails": {},
"errors": ["abc123"],
"slackConnection": SlackConnection,
"viewer": CurrentUser
}
}
}
updateStripeAccount
Description
Update a stripe account
Response
Returns an UpdateStripeAccountPayload!
Arguments
| Name | Description |
|---|---|
attributes - StripeAccountUpdateAttributes!
|
Example
Query
mutation updateStripeAccount($attributes: StripeAccountUpdateAttributes!) {
updateStripeAccount(attributes: $attributes) {
account {
...StripeAccountDetailsFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": StripeAccountUpdateAttributes}
Response
{
"data": {
"updateStripeAccount": {
"account": StripeAccountDetails,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
}
}
updateStripeCustomer
Description
Update a stripe customer
Response
Returns an UpdateStripeCustomerPayload!
Arguments
| Name | Description |
|---|---|
token - String!
|
Example
Query
mutation updateStripeCustomer($token: String!) {
updateStripeCustomer(token: $token) {
customer {
...StripeCustomerFragment
}
errorDetails
errors
viewer {
...CurrentUserFragment
}
}
}
Variables
{"token": "abc123"}
Response
{
"data": {
"updateStripeCustomer": {
"customer": StripeCustomer,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
}
}
updateSubdiscipline
Description
Update a subdiscipline
Response
Returns an UpdateSubdisciplinePayload!
Arguments
| Name | Description |
|---|---|
attributes - SubdisciplineAttributes!
|
|
id - ID!
|
Example
Query
mutation updateSubdiscipline(
$attributes: SubdisciplineAttributes!,
$id: ID!
) {
updateSubdiscipline(
attributes: $attributes,
id: $id
) {
errorDetails
errors
subdiscipline {
...SubdisciplineFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": SubdisciplineAttributes, "id": 4}
Response
{
"data": {
"updateSubdiscipline": {
"errorDetails": {},
"errors": ["abc123"],
"subdiscipline": Subdiscipline,
"viewer": CurrentUser
}
}
}
updateSurveyQuestion
Description
Update a survey question
Response
Returns an UpdateSurveyQuestionPayload!
Arguments
| Name | Description |
|---|---|
attributes - SurveyQuestionAttributes!
|
|
id - ID!
|
Example
Query
mutation updateSurveyQuestion(
$attributes: SurveyQuestionAttributes!,
$id: ID!
) {
updateSurveyQuestion(
attributes: $attributes,
id: $id
) {
errorDetails
errors
surveyQuestion {
...SurveyQuestionFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"attributes": SurveyQuestionAttributes,
"id": "4"
}
Response
{
"data": {
"updateSurveyQuestion": {
"errorDetails": {},
"errors": ["abc123"],
"surveyQuestion": SurveyQuestion,
"viewer": CurrentUser
}
}
}
updateTag
Description
Update a tag
Response
Returns an UpdateTagPayload!
Arguments
| Name | Description |
|---|---|
attributes - TagAttributes!
|
|
id - ID!
|
Example
Query
mutation updateTag(
$attributes: TagAttributes!,
$id: ID!
) {
updateTag(
attributes: $attributes,
id: $id
) {
errorDetails
errors
tag {
...TagFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{"attributes": TagAttributes, "id": 4}
Response
{
"data": {
"updateTag": {
"errorDetails": {},
"errors": ["xyz789"],
"tag": Tag,
"viewer": CurrentUser
}
}
}
updateTimeSlot
Description
Update a time slot
Response
Returns an UpdateTimeSlotPayload!
Arguments
| Name | Description |
|---|---|
attributes - TimeSlotAttributes!
|
|
id - ID!
|
|
userId - ID
|
Example
Query
mutation updateTimeSlot(
$attributes: TimeSlotAttributes!,
$id: ID!,
$userId: ID
) {
updateTimeSlot(
attributes: $attributes,
id: $id,
userId: $userId
) {
errorDetails
errors
timeSlot {
...TimeSlotFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"attributes": TimeSlotAttributes,
"id": "4",
"userId": "4"
}
Response
{
"data": {
"updateTimeSlot": {
"errorDetails": {},
"errors": ["abc123"],
"timeSlot": TimeSlot,
"viewer": CurrentUser
}
}
}
updateTranslations
Description
Update a translations
Response
Returns an UpdateTranslationsPayload!
Arguments
| Name | Description |
|---|---|
groupId - ID!
|
|
translations - [TranslationInput!]!
|
Example
Query
mutation updateTranslations(
$groupId: ID!,
$translations: [TranslationInput!]!
) {
updateTranslations(
groupId: $groupId,
translations: $translations
) {
errorDetails
errors
surveyQuestions {
...SurveyQuestionFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"groupId": "4",
"translations": [TranslationInput]
}
Response
{
"data": {
"updateTranslations": {
"errorDetails": {},
"errors": ["xyz789"],
"surveyQuestions": [SurveyQuestion],
"viewer": CurrentUser
}
}
}
updateUser
Description
Update a user
Response
Returns an UpdateUserPayload!
Arguments
| Name | Description |
|---|---|
attributes - UserAttributes!
|
|
id - ID!
|
Example
Query
mutation updateUser(
$attributes: UserAttributes!,
$id: ID!
) {
updateUser(
attributes: $attributes,
id: $id
) {
errorDetails
errors
user {
...ManagedUserFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"attributes": UserAttributes,
"id": "4"
}
Response
{
"data": {
"updateUser": {
"errorDetails": {},
"errors": ["xyz789"],
"user": ManagedUser,
"viewer": CurrentUser
}
}
}
updateUserFile
Description
Update a user file
Response
Returns an UpdateUserFilePayload!
Arguments
| Name | Description |
|---|---|
file - UploadAttributes
|
|
id - ID!
|
Example
Query
mutation updateUserFile(
$file: UploadAttributes,
$id: ID!
) {
updateUserFile(
file: $file,
id: $id
) {
errorDetails
errors
userFile {
...UserFileFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"file": UploadAttributes,
"id": "4"
}
Response
{
"data": {
"updateUserFile": {
"errorDetails": {},
"errors": ["xyz789"],
"userFile": UserFile,
"viewer": CurrentUser
}
}
}
updateUserGoal
Description
Update a user goal
Response
Returns an UpdateUserGoalPayload!
Example
Query
mutation updateUserGoal(
$achievementReflection: String,
$goalId: ID!,
$goalText: String
) {
updateUserGoal(
achievementReflection: $achievementReflection,
goalId: $goalId,
goalText: $goalText
) {
errorDetails
errors
goal {
...UserGoalFragment
}
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"achievementReflection": "abc123",
"goalId": 4,
"goalText": "abc123"
}
Response
{
"data": {
"updateUserGoal": {
"errorDetails": {},
"errors": ["xyz789"],
"goal": UserGoal,
"viewer": CurrentUser
}
}
}
updateWorkingHours
Description
Update a working hours
Response
Returns an UpdateWorkingHoursPayload!
Arguments
| Name | Description |
|---|---|
workingHours - [WorkingHourInput!]!
|
Example
Query
mutation updateWorkingHours($workingHours: [WorkingHourInput!]!) {
updateWorkingHours(workingHours: $workingHours) {
errorDetails
errors
viewer {
...CurrentUserFragment
}
workingHours {
...WorkingHourFragment
}
}
}
Variables
{"workingHours": [WorkingHourInput]}
Response
{
"data": {
"updateWorkingHours": {
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser,
"workingHours": [WorkingHour]
}
}
}
validateCalendarUrl
Description
Validate a calendar url
Response
Returns a ValidateCalendarUrlPayload!
Arguments
| Name | Description |
|---|---|
url - String!
|
Example
Query
mutation validateCalendarUrl($url: String!) {
validateCalendarUrl(url: $url) {
errorDetails
errors
isValid
viewer {
...CurrentUserFragment
}
}
}
Variables
{"url": "xyz789"}
Response
{
"data": {
"validateCalendarUrl": {
"errorDetails": {},
"errors": ["abc123"],
"isValid": false,
"viewer": CurrentUser
}
}
}
validateResetPasswordToken
Description
Validate a reset password token
Response
Returns a ValidateResetPasswordTokenPayload!
Example
Query
mutation validateResetPasswordToken(
$email: String!,
$groupId: ID,
$token: ID!
) {
validateResetPasswordToken(
email: $email,
groupId: $groupId,
token: $token
) {
errorDetails
errors
isValid
viewer {
...CurrentUserFragment
}
}
}
Variables
{
"email": "xyz789",
"groupId": 4,
"token": 4
}
Response
{
"data": {
"validateResetPasswordToken": {
"errorDetails": {},
"errors": ["xyz789"],
"isValid": "abc123",
"viewer": CurrentUser
}
}
}
Types
AcceptBookingRequestPayload
Description
Autogenerated return type of AcceptBookingRequest
Fields
| Field Name | Description |
|---|---|
booking - Booking
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"booking": Booking,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
Account
Description
Account type
Fields
| Field Name | Description |
|---|---|
groups - [Group!]!
|
|
id - ID!
|
|
inAppBilling - Boolean!
|
|
name - String!
|
|
plan - Plan
|
|
requiresPlan - Boolean!
|
|
slug - String!
|
|
stripeAccount - StripeAccount
|
|
stripeAccountLink - String
|
|
stripeCustomer - StripeCustomer
|
|
trialEndsAt - ISO8601DateTime
|
|
users - [ManagedUser!]
|
Example
{
"groups": [Group],
"id": 4,
"inAppBilling": true,
"name": "xyz789",
"plan": Plan,
"requiresPlan": true,
"slug": "abc123",
"stripeAccount": StripeAccount,
"stripeAccountLink": "abc123",
"stripeCustomer": StripeCustomer,
"trialEndsAt": ISO8601DateTime,
"users": [ManagedUser]
}
ActivateInAppBillingPayload
Description
Autogenerated return type of ActivateInAppBilling
Fields
| Field Name | Description |
|---|---|
account - Account!
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"account": Account,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
ActivateMatchesPayload
Description
Autogenerated return type of ActivateMatches
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
updatedRecordCount - Int!
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"updatedRecordCount": 987,
"viewer": CurrentUser
}
ActivateStagedMatchesPayload
Description
Autogenerated return type of ActivateStagedMatches
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
updatedRecordCount - Int!
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"updatedRecordCount": 987,
"viewer": CurrentUser
}
ActivateTopMatchesPayload
Description
Autogenerated return type of ActivateTopMatches
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
status - String!
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"status": "abc123",
"viewer": CurrentUser
}
AddAuthenticatorPayload
Description
Autogenerated return type of AddAuthenticator
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
user - CurrentUser
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"user": CurrentUser,
"viewer": CurrentUser
}
AddBookingPayload
Description
Autogenerated return type of AddBooking
Fields
| Field Name | Description |
|---|---|
booking - Booking
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"booking": Booking,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
AiTranslateProgramPayload
Description
Autogenerated return type of AiTranslateProgram
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
results - [AiTranslationResult!]
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"results": [AiTranslationResult],
"viewer": CurrentUser
}
AiTranslationResult
Fields
| Field Name | Description |
|---|---|
errors - [String!]!
|
|
locale - String!
|
|
skippedCount - Int!
|
|
translatedCount - Int!
|
Example
{
"errors": ["xyz789"],
"locale": "abc123",
"skippedCount": 987,
"translatedCount": 123
}
AlternateUser
AnalysisMetadata
ApiKey
Description
An API key for programmatic access to the Mentorly API. The plaintext secret is returned only at creation/rotation and never re-fetchable.
Fields
| Field Name | Description |
|---|---|
account - Account!
|
Account this key belongs to. |
active - Boolean!
|
|
createdAt - ISO8601DateTime!
|
|
expiresAt - ISO8601DateTime
|
|
groupIds - [ID!]!
|
Groups this key may access. Empty means account-wide. |
id - ID!
|
Database identifier. |
keyPrefix - String!
|
Public, indexed identifier (mk_live_<8 hex>). Used as the lookup half of the token; safe to display. |
lastUsedAt - ISO8601DateTime
|
|
name - String!
|
Human-readable label. |
rateLimitTier - String!
|
Throttle bucket — standard or enterprise. |
scopes - [String!]!
|
Permission scopes this key grants (e.g. read:bookings). |
user - ManagedUser
|
When present, the key is user-delegated and the API behaves exactly as if this user were logged in. |
Example
{
"account": Account,
"active": true,
"createdAt": ISO8601DateTime,
"expiresAt": ISO8601DateTime,
"groupIds": [4],
"id": "4",
"keyPrefix": "abc123",
"lastUsedAt": ISO8601DateTime,
"name": "xyz789",
"rateLimitTier": "xyz789",
"scopes": ["xyz789"],
"user": ManagedUser
}
ArchiveGroupPayload
Description
Autogenerated return type of ArchiveGroup
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
group - ManagedGroup
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"group": ManagedGroup,
"viewer": CurrentUser
}
ArchiveGroupUsersPayload
Description
Autogenerated return type of ArchiveGroupUsers
Fields
| Field Name | Description |
|---|---|
archivedUsersCount - Int!
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"archivedUsersCount": 987,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
ArchiveUserPayload
Description
Autogenerated return type of ArchiveUser
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
user - ManagedUser
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"user": ManagedUser,
"viewer": CurrentUser
}
AuthProviderEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"facebook"
AuthenticateUserPayload
Description
Autogenerated return type of AuthenticateUser
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
loginUrl - String
|
|
otpRequiredForLogin - Boolean!
|
|
user - CurrentUser
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"loginUrl": "abc123",
"otpRequiredForLogin": false,
"user": CurrentUser,
"viewer": CurrentUser
}
Availability
Fields
| Field Name | Description |
|---|---|
allowGroupSessions - Boolean!
|
|
endTime - ISO8601DateTime!
|
|
id - ID!
|
|
location - Location
|
|
startTime - ISO8601DateTime!
|
Example
{
"allowGroupSessions": true,
"endTime": ISO8601DateTime,
"id": 4,
"location": Location,
"startTime": ISO8601DateTime
}
AvailabilityDate
Fields
| Field Name | Description |
|---|---|
date - ISO8601DateTime!
|
|
id - ID!
|
|
userAvailabilities - [AvailabilityUser!]!
|
Example
{
"date": ISO8601DateTime,
"id": 4,
"userAvailabilities": [AvailabilityUser]
}
AvailabilityUser
Fields
| Field Name | Description |
|---|---|
availabilities - [Availability!]!
|
|
id - ID!
|
|
user - User!
|
Example
{
"availabilities": [Availability],
"id": "4",
"user": User
}
Avatar
BenefitContent
Example
{
"body": "xyz789",
"id": 4,
"imageUrl": "xyz789",
"key": 4,
"title": "xyz789"
}
BlogContent
Description
Blog content
Fields
| Field Name | Description |
|---|---|
body - String
|
|
bodyHtml - String
|
|
categories - [String!]!
|
|
description - String
|
|
Arguments
|
|
id - ID!
|
|
key - ID!
|
|
publishedAt - ISO8601DateTime
|
|
title - String
|
|
Arguments
|
|
updatedAt - ISO8601DateTime!
|
|
Example
{
"body": "abc123",
"bodyHtml": "abc123",
"categories": ["abc123"],
"description": "abc123",
"id": "4",
"key": 4,
"publishedAt": ISO8601DateTime,
"title": "abc123",
"updatedAt": ISO8601DateTime
}
Booking
Description
A booking
Fields
| Field Name | Description |
|---|---|
calendarLinks - [CalendarLink!]!
|
|
cancellationReason - String
|
|
conferenceUrl - String!
|
|
Arguments
|
|
conversation - Conversation
|
|
createdAt - ISO8601DateTime!
|
|
defaultTitle - String!
|
|
description - String
|
|
Arguments
|
|
duration - Int!
|
|
endTime - ISO8601DateTime!
|
|
group - Group!
|
|
groupSession - Boolean!
|
|
guests - [User!]!
|
|
hosts - [User!]!
|
|
id - ID!
|
|
isExternalBooking - Boolean!
|
|
isFull - Boolean!
|
|
isMentor - Boolean!
|
|
isParticipating - Boolean!
|
|
isRequest - Boolean!
|
|
jitsiRoomId - String
|
|
jitsiToken - String
|
|
lastReviewByViewer - Review
|
|
location - Location
|
|
maxParticipants - Int
|
|
mentee - User
|
|
mentor - User
|
|
minParticipants - Int
|
|
otherGuests - [User!]!
|
|
otherParticipants - [User!]!
|
|
participants - [User!]!
|
|
participations - [BookingParticipation!]!
|
|
pid - ID!
|
|
sessionType - String!
|
|
startTime - ISO8601DateTime!
|
|
status - String!
|
|
syncedToCalendar - Boolean!
|
|
title - String
|
|
type - BookingTypeEnum!
|
|
Example
{
"calendarLinks": [CalendarLink],
"cancellationReason": "abc123",
"conferenceUrl": "abc123",
"conversation": Conversation,
"createdAt": ISO8601DateTime,
"defaultTitle": "xyz789",
"description": "xyz789",
"duration": 123,
"endTime": ISO8601DateTime,
"group": Group,
"groupSession": false,
"guests": [User],
"hosts": [User],
"id": 4,
"isExternalBooking": false,
"isFull": true,
"isMentor": false,
"isParticipating": false,
"isRequest": false,
"jitsiRoomId": "xyz789",
"jitsiToken": "xyz789",
"lastReviewByViewer": Review,
"location": Location,
"maxParticipants": 987,
"mentee": User,
"mentor": User,
"minParticipants": 123,
"otherGuests": [User],
"otherParticipants": [User],
"participants": [User],
"participations": [BookingParticipation],
"pid": 4,
"sessionType": "xyz789",
"startTime": ISO8601DateTime,
"status": "xyz789",
"syncedToCalendar": true,
"title": "xyz789",
"type": "booking"
}
BookingAttributes
Example
{
"description": "xyz789",
"duration": 987,
"guestIds": ["4"],
"hostIds": ["4"],
"locationId": "4",
"maxParticipants": 123,
"mentorId": 4,
"minParticipants": 123,
"participantIds": [4],
"sessionType": "abc123",
"startTime": "xyz789",
"title": "xyz789"
}
BookingParticipation
BookingRequest
Fields
| Field Name | Description |
|---|---|
calendarLinks - [CalendarLink!]!
|
|
conversation - Conversation
|
|
creator - User
|
|
description - String
|
|
duration - Int!
|
|
endTime - ISO8601DateTime!
|
|
groupSession - Boolean!
|
|
guests - [User!]!
|
|
hosts - [User!]!
|
|
id - ID!
|
|
isCreator - Boolean!
|
|
isMentee - Boolean!
|
|
isMentor - Boolean!
|
|
isRequest - Boolean!
|
|
location - Location
|
|
mentee - User
|
|
mentor - User
|
|
otherGuests - [User!]!
|
|
otherParticipants - [User!]!
|
|
participants - [User!]!
|
|
startTime - ISO8601DateTime!
|
|
status - String!
|
|
title - String
|
|
type - BookingTypeEnum!
|
Example
{
"calendarLinks": [CalendarLink],
"conversation": Conversation,
"creator": User,
"description": "xyz789",
"duration": 987,
"endTime": ISO8601DateTime,
"groupSession": true,
"guests": [User],
"hosts": [User],
"id": 4,
"isCreator": true,
"isMentee": false,
"isMentor": true,
"isRequest": true,
"location": Location,
"mentee": User,
"mentor": User,
"otherGuests": [User],
"otherParticipants": [User],
"participants": [User],
"startTime": ISO8601DateTime,
"status": "xyz789",
"title": "xyz789",
"type": "booking"
}
BookingRequestAttributes
Example
{
"endTime": "xyz789",
"groupSession": true,
"invitedParticipantIds": [4],
"isSuggestedTime": false,
"locationId": 4,
"mentorId": "4",
"startTime": "abc123",
"userMessage": "abc123"
}
BookingStatusEnum
Description
status of bookings
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"accepted"
BookingTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"booking"
Boolean
Description
The Boolean scalar type represents true or false.
CalculateGroupMatchesPayload
Description
Autogenerated return type of CalculateGroupMatches
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
status - String!
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"status": "abc123",
"viewer": CurrentUser
}
CalendarConnection
Description
Calendar + conferencing settings for the current user
Fields
| Field Name | Description |
|---|---|
accounts - [CronofyProfile!]!
|
Cronofy profiles (one per connected calendar account) and their calendars |
conferencingProvider - String
|
Empty string = Mentorly default; 'external' = external provider |
needsReauth - Boolean!
|
True if Cronofy returned an auth error and the user must reconnect |
selectedCalendarId - String
|
The calendar id Cronofy syncs bookings into |
Example
{
"accounts": [CronofyProfile],
"conferencingProvider": "abc123",
"needsReauth": false,
"selectedCalendarId": "abc123"
}
CalendarLink
CancelBookingPayload
Description
Autogenerated return type of CancelBooking
Fields
| Field Name | Description |
|---|---|
booking - Booking
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"booking": Booking,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
CancelBookingRequestPayload
Description
Autogenerated return type of CancelBookingRequest
Fields
| Field Name | Description |
|---|---|
bookingRequest - BookingRequest
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"bookingRequest": BookingRequest,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
CancelPendingInvitationEmailsPayload
Description
Autogenerated return type of CancelPendingInvitationEmails
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
status - String
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"status": "xyz789",
"viewer": CurrentUser
}
CancelStagedMatchesPayload
Description
Autogenerated return type of CancelStagedMatches
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
updatedRecordCount - Int!
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"updatedRecordCount": 123,
"viewer": CurrentUser
}
CareerDevelopmentRecommendation
Description
A career development recommendation with details and implementation steps
Fields
| Field Name | Description |
|---|---|
description - String!
|
Brief description of the recommended career development activity |
expectedOutcome - String!
|
Expected outcomes or benefits from implementing this recommendation |
howToMeasure - String!
|
Specific metrics or indicators to measure the success of this recommendation |
implementation - String!
|
Detailed steps on how to implement this recommendation |
priority - String!
|
Priority level of the recommendation (High, Medium, Low) |
title - String!
|
Title of the career development recommendation |
Example
{
"description": "xyz789",
"expectedOutcome": "xyz789",
"howToMeasure": "xyz789",
"implementation": "xyz789",
"priority": "abc123",
"title": "abc123"
}
CareerDevelopmentRecommendationsAnalysis
Description
Analysis of career development recommendations for mentees
Fields
| Field Name | Description |
|---|---|
metadata - AnalysisMetadata!
|
Metadata about the analysis including prompt used and input data |
recommendations - [CareerDevelopmentRecommendation!]!
|
List of career development recommendations with details |
summary - String!
|
Brief summary of overall career development recommendations |
Example
{
"metadata": AnalysisMetadata,
"recommendations": [CareerDevelopmentRecommendation],
"summary": "abc123"
}
Cohort
CohortAttributes
Fields
| Input Field | Description |
|---|---|
name - String!
|
Example
{"name": "abc123"}
CompanyValueContent
Example
{
"description": "abc123",
"id": 4,
"imageUrl": "abc123",
"key": 4,
"title": "xyz789",
"valueType": "4"
}
ComparisonTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
Equal to |
|
|
Greater than or equal to |
|
|
Less than or equal to |
Example
"eq"
CompleteUserGoalPayload
Description
Autogenerated return type of CompleteUserGoal
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
goal - UserGoal
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"goal": UserGoal,
"viewer": CurrentUser
}
Conference
Fields
| Field Name | Description |
|---|---|
conversation - Conversation!
|
The conversation for this conference |
endTime - ISO8601DateTime!
|
The start of the conference |
id - ID!
|
The ID |
mentee - User!
|
The mentee for the conference |
mentor - User!
|
The mentor for the conference |
name - String!
|
The name of the conference |
participants - [User!]!
|
The list of participants |
roomId - ID!
|
The room ID |
startTime - ISO8601DateTime!
|
The start of the conference |
token - ID!
|
A token for the user and the given room |
Example
{
"conversation": Conversation,
"endTime": ISO8601DateTime,
"id": 4,
"mentee": User,
"mentor": User,
"name": "xyz789",
"participants": [User],
"roomId": 4,
"startTime": ISO8601DateTime,
"token": 4
}
ConnectSlackByEmailPayload
Description
Autogenerated return type of ConnectSlackByEmail
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
slackConnection - SlackConnection
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"slackConnection": SlackConnection,
"viewer": CurrentUser
}
ConnectedCalendar
ConnectionInfo
Example
{
"calendarProvider": true,
"connected": true,
"connectionUrl": "abc123",
"disconnectable": true,
"email": "xyz789",
"id": 4,
"loginProvider": false,
"meetingProvider": true,
"name": "abc123",
"needsAuth": false
}
Conversation
Description
Conversation
Fields
| Field Name | Description |
|---|---|
events - [ConversationEvent!]!
|
The events |
groupConversation - Boolean!
|
|
id - ID!
|
The ID |
internalId - ID!
|
|
isAnnouncement - Boolean
|
An annoucement is a one-way message thread |
isFiltering - Boolean
|
Was the conversation created with filters, since not all announcements are filtering |
lastEventAt - ISO8601DateTime
|
|
lastVisitedAt - ISO8601DateTime
|
|
Arguments
|
|
memberCount - Int!
|
The number of members in the conversation |
memberFilters - MemberFilters
|
Filters used to make this selection of users |
members - [User!]!
|
The members of the conversation |
memberships - [ConversationMembership!]!
|
|
messageCursor - ID
|
|
messages - [Message!]!
|
The messages |
name - String
|
The name of the conversation |
otherMembers - [User!]!
|
The members of the conversation other than current user |
otherMembersCount - Int!
|
The number of members in the conversation other than current user |
otherRecipients - [User!]
|
Users other than current user who received the initial message |
recipientIds - [ID!]
|
|
recipients - [User!]
|
Users who received the initial message |
sender - User
|
User who started the conversation |
Example
{
"events": [Message],
"groupConversation": false,
"id": 4,
"internalId": 4,
"isAnnouncement": true,
"isFiltering": false,
"lastEventAt": ISO8601DateTime,
"lastVisitedAt": ISO8601DateTime,
"memberCount": 123,
"memberFilters": MemberFilters,
"members": [User],
"memberships": [ConversationMembership],
"messageCursor": 4,
"messages": [Message],
"name": "abc123",
"otherMembers": [User],
"otherMembersCount": 123,
"otherRecipients": [User],
"recipientIds": [4],
"recipients": [User],
"sender": User
}
ConversationEvent
Types
| Union Types |
|---|
Example
Message
ConversationMembership
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
lastVisitedAt - ISO8601DateTime!
|
|
user - User
|
Example
{
"id": "4",
"lastVisitedAt": ISO8601DateTime,
"user": User
}
Country
CreateApiKeyPayload
Description
Autogenerated return type of CreateApiKey
Fields
| Field Name | Description |
|---|---|
apiKey - ApiKey
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
plaintextToken - String
|
The full token (mk_live_ |
viewer - CurrentUser
|
Example
{
"apiKey": ApiKey,
"errorDetails": {},
"errors": ["xyz789"],
"plaintextToken": "abc123",
"viewer": CurrentUser
}
CreateBookingParticipationPayload
Description
Autogenerated return type of CreateBookingParticipation
Fields
| Field Name | Description |
|---|---|
booking - Booking
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"booking": Booking,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
CreateBookingRequestPayload
Description
Autogenerated return type of CreateBookingRequest
Fields
| Field Name | Description |
|---|---|
booking - Booking
|
|
bookingRequest - BookingRequest
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"booking": Booking,
"bookingRequest": BookingRequest,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
CreateCohortPayload
Description
Autogenerated return type of CreateCohort
Fields
| Field Name | Description |
|---|---|
cohort - Cohort
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"cohort": Cohort,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
CreateConversationFilePayload
Description
Autogenerated return type of CreateConversationFile
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
message - Upload
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"message": Upload,
"viewer": CurrentUser
}
CreateConversationPayload
Description
Autogenerated return type of CreateConversation
Fields
| Field Name | Description |
|---|---|
conversation - Conversation!
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"conversation": Conversation,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
CreateDisciplinePayload
Description
Autogenerated return type of CreateDiscipline
Fields
| Field Name | Description |
|---|---|
discipline - Discipline
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"discipline": Discipline,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
CreateGoalProgressNotePayload
Description
Autogenerated return type of CreateGoalProgressNote
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
goal - UserGoal
|
|
progressNote - GoalProgressNote
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"goal": UserGoal,
"progressNote": GoalProgressNote,
"viewer": CurrentUser
}
CreateGroupConversationPayload
Description
Autogenerated return type of CreateGroupConversation
Fields
| Field Name | Description |
|---|---|
conversation - Conversation
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"conversation": Conversation,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
CreateGroupFilePayload
Description
Autogenerated return type of CreateGroupFile
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
groupFile - GroupFile
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"groupFile": GroupFile,
"viewer": CurrentUser
}
CreateGroupMatchesPayload
Description
Autogenerated return type of CreateGroupMatches
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
status - String!
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"status": "abc123",
"viewer": CurrentUser
}
CreateMatchPayload
Description
Autogenerated return type of CreateMatch
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
match - MentorMatch
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"match": MentorMatch,
"viewer": CurrentUser
}
CreateMatchesFromPreviewPayload
Description
Autogenerated return type of CreateMatchesFromPreview
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
matchesCreated - Int
|
|
matchingRun - MatchingRun
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"matchesCreated": 123,
"matchingRun": MatchingRun,
"viewer": CurrentUser
}
CreateMessagePayload
Description
Autogenerated return type of CreateMessage
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
message - Message
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"message": Message,
"viewer": CurrentUser
}
CreateOtpProvisioningUriPayload
Description
Autogenerated return type of CreateOtpProvisioningUri
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
otpProvisioningUri - String!
|
|
user - User
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"otpProvisioningUri": "xyz789",
"user": User,
"viewer": CurrentUser
}
CreateReviewPayload
Description
Autogenerated return type of CreateReview
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
review - Review
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"review": Review,
"viewer": CurrentUser
}
CreateStripeAccountPayload
Description
Autogenerated return type of CreateStripeAccount
Fields
| Field Name | Description |
|---|---|
account - StripeAccountDetails
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"account": StripeAccountDetails,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
CreateStripeCustomerPayload
Description
Autogenerated return type of CreateStripeCustomer
Fields
| Field Name | Description |
|---|---|
customer - StripeCustomer
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"customer": StripeCustomer,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
CreateSubdisciplinePayload
Description
Autogenerated return type of CreateSubdiscipline
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
subdiscipline - Subdiscipline
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"subdiscipline": Subdiscipline,
"viewer": CurrentUser
}
CreateSurveyQuestionPayload
Description
Autogenerated return type of CreateSurveyQuestion
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
surveyQuestion - SurveyQuestion
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"surveyQuestion": SurveyQuestion,
"viewer": CurrentUser
}
CreateSurveyResultPayload
Description
Autogenerated return type of CreateSurveyResult
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
user - ManagedUser
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"user": ManagedUser,
"viewer": CurrentUser
}
CreateTagPayload
Description
Autogenerated return type of CreateTag
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
tag - Tag
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"tag": Tag,
"viewer": CurrentUser
}
CreateTimeSlotPayload
Description
Autogenerated return type of CreateTimeSlot
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
timeSlot - TimeSlot
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"timeSlot": TimeSlot,
"viewer": CurrentUser
}
CreateUserFilePayload
Description
Autogenerated return type of CreateUserFile
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
userFile - UserFile
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"userFile": UserFile,
"viewer": CurrentUser
}
CreateUserGoalPayload
Description
Autogenerated return type of CreateUserGoal
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
goal - UserGoal
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"goal": UserGoal,
"viewer": CurrentUser
}
CreateUserPayload
Description
Autogenerated return type of CreateUser
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
user - ManagedUser
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"user": ManagedUser,
"viewer": CurrentUser
}
CronofyCalendar
CronofyProfile
Description
A connected Cronofy calendar account
Fields
| Field Name | Description |
|---|---|
calendars - [CronofyCalendar!]!
|
|
connected - Boolean!
|
True if Cronofy considers the profile in good standing |
id - ID!
|
|
name - String!
|
|
providerName - String
|
Slug like 'google', 'microsoft', 'apple', or nil if unknown |
Example
{
"calendars": [CronofyCalendar],
"connected": false,
"id": "4",
"name": "xyz789",
"providerName": "abc123"
}
CurrentUser
Description
The current user
Fields
| Field Name | Description |
|---|---|
account - Account
|
|
Arguments
|
|
accounts - [Account!]!
|
|
activeGoals - [UserGoal!]!
|
|
activeSubscription - Boolean!
|
|
allowGroupSessions - Boolean!
|
|
alternates - [AlternateUser!]!
|
|
availabilities - [Availability!]!
|
|
Arguments
|
|
availabilityCalendarId - ID
|
|
availabilityCounts - [DateCount!]!
|
|
Arguments
|
|
avatar - Avatar!
|
|
behanceLink - String
|
|
bookable - Boolean!
|
|
booking - Booking
|
|
Arguments
|
|
bookingCount - Int!
|
|
Arguments
|
|
bookingLink - String
|
|
bookingRequestCount - Int!
|
|
Arguments
|
|
bookingRequests - [BookingRequest!]!
|
|
bookings - [Booking!]!
|
|
Arguments
|
|
calendarConnection - CalendarConnection
|
Calendar + conferencing settings for the Connections page |
calendarId - ID
|
|
calendarProvider - String
|
|
calendarUrl - String
|
|
cancellationPolicy - String!
|
|
cohort - Cohort
|
|
company - String
|
|
completedGoals - [UserGoal!]!
|
|
Arguments
|
|
conference - Conference
|
A conference |
Arguments
|
|
conferences - [Conference!]
|
The current user's conferences |
connectedCalendars - [ConnectedCalendar!]!
|
|
Arguments
|
|
connections - UserConnections!
|
|
contactEmail - String!
|
|
conversation - Conversation
|
|
Arguments
|
|
conversationCount - Int!
|
|
Arguments
|
|
conversations - [Conversation!]!
|
|
country - Country
|
|
countryCode - String
|
|
createdAt - ISO8601DateTime!
|
|
createdUsing - String
|
|
dateOfBirth - ISO8601Date
|
User's date of birth |
description - String
|
|
discipline - Discipline
|
|
disciplineNames - [String!]!
|
|
disciplines - [Discipline!]!
|
|
dribbbleLink - String
|
|
effectiveMenteeCapacity - Int
|
|
effectiveMentorCapacity - Int
|
|
email - String!
|
|
experience - Int
|
|
extensionNumber - String
|
|
facebookLink - String
|
|
files - [UserFile!]!
|
|
firstName - String
|
|
gender - String
|
|
goals - [UserGoal!]!
|
|
Arguments
|
|
group - Group
|
|
groupSessions - [Booking!]!
|
|
hardSkills - String
|
|
hasAvailability - Boolean!
|
|
id - ID!
|
|
instagramLink - String
|
|
intercomHash - String
|
|
invoiceList - InvoiceList
|
|
Arguments
|
|
isActive - Boolean!
|
|
isMatched - Boolean
|
Whether this user is matched with the current user |
languages - [Language!]!
|
|
lastName - String
|
|
lastSignInAt - ISO8601DateTime
|
|
legacyGroup - Boolean!
|
|
linkedinLink - String
|
|
location - String
|
|
longTermGoals - String
|
|
managedGroup - ManagedGroup
|
|
Arguments
|
|
managedGroups - [ManagedGroup!]!
|
|
market - String
|
|
masterclasses - [Booking!]!
|
|
matchingPercent - Int!
|
|
meetingProvider - String
|
|
menteeCapacity - Int
|
|
menteeMatches - [MentorMatch!]!
|
|
menteeMatchesRemaining - Int
|
|
menteeSessionsRemaining - Int
|
|
mentor - Boolean!
|
|
mentorCapacity - Int
|
|
mentorMatches - [MentorMatch!]!
|
|
mentorMatchesRemaining - Int
|
|
mentorSessionsRemaining - Int
|
|
mentorlyAdmin - Boolean
|
|
missingMatchingFields - [String!]!
|
|
missingProfileFields - [String!]!
|
|
name - String!
|
|
needsAuth - Boolean!
|
|
needsCalendarConnection - Boolean!
|
|
newProfileImage - UploadedFile
|
|
newProfileImageUrl - String
|
|
nextSteps - [NextStep!]!
|
|
Arguments
|
|
nylasEnabled - Boolean!
|
|
onboarded - Boolean!
|
|
onboardingPercent - Int!
|
|
otpRequiredForLogin - Boolean!
|
|
paymentRequired - Boolean!
|
|
peopleNetwork - [String!]!
|
|
phoneNumber - String
|
|
preferredLanguage - Language!
|
|
profileImagePath - String
|
|
profileImageSettings - ImageSettings!
|
|
profileImageUrl - String
|
|
profilePercent - Int!
|
|
pronouns - String
|
|
publicProfileSegments - [PublicProfileSegment!]!
|
|
Arguments
|
|
publicTagList - [String!]!
|
|
Arguments
|
|
rate30 - Int
|
|
rate60 - Int
|
|
rates - JSON
|
|
role - String
|
|
sessionLengths - [Int!]!
|
|
sessionsRemaining - Int
|
|
shortTermGoals - String
|
|
signInThrough - String
|
|
signUpThrough - String
|
|
skills - String
|
|
slackConnection - SlackConnection
|
Slack workspace + mapping + notification preference for the Connections page |
slug - String
|
|
socialLinks - [SocialLink!]!
|
|
softSkills - String
|
|
status - String!
|
|
stripeAccount - StripeAccount
|
|
stripeAccountLink - String
|
|
stripeCustomer - StripeCustomer
|
|
subdisciplineNames - [String!]!
|
|
subdisciplines - [Subdiscipline!]!
|
|
surveyResult - SurveyResult
|
|
tags - [Tag!]!
|
|
tier - String
|
|
timeSlot - TimeSlot
|
|
Arguments
|
|
timeSlots - [TimeSlot!]!
|
|
Arguments
|
|
timezone - String
|
|
token - ID!
|
|
twitterLink - String
|
|
uid - ID!
|
|
unconfirmedBookings - [Booking!]!
|
|
unreadConversationCount - Int!
|
|
userRole - String!
|
|
vimeoLink - String
|
|
website - String
|
|
welcomeMessage - String
|
|
workingHours - [WorkingHour!]!
|
|
youtubeLink - String
|
|
Example
{
"account": Account,
"accounts": [Account],
"activeGoals": [UserGoal],
"activeSubscription": false,
"allowGroupSessions": true,
"alternates": [AlternateUser],
"availabilities": [Availability],
"availabilityCalendarId": "4",
"availabilityCounts": [DateCount],
"avatar": Avatar,
"behanceLink": "xyz789",
"bookable": false,
"booking": Booking,
"bookingCount": 987,
"bookingLink": "abc123",
"bookingRequestCount": 987,
"bookingRequests": [BookingRequest],
"bookings": [Booking],
"calendarConnection": CalendarConnection,
"calendarId": "4",
"calendarProvider": "abc123",
"calendarUrl": "abc123",
"cancellationPolicy": "xyz789",
"cohort": Cohort,
"company": "xyz789",
"completedGoals": [UserGoal],
"conference": Conference,
"conferences": [Conference],
"connectedCalendars": [ConnectedCalendar],
"connections": UserConnections,
"contactEmail": "xyz789",
"conversation": Conversation,
"conversationCount": 987,
"conversations": [Conversation],
"country": Country,
"countryCode": "xyz789",
"createdAt": ISO8601DateTime,
"createdUsing": "xyz789",
"dateOfBirth": ISO8601Date,
"description": "abc123",
"discipline": Discipline,
"disciplineNames": ["xyz789"],
"disciplines": [Discipline],
"dribbbleLink": "abc123",
"effectiveMenteeCapacity": 987,
"effectiveMentorCapacity": 123,
"email": "xyz789",
"experience": 987,
"extensionNumber": "xyz789",
"facebookLink": "xyz789",
"files": [UserFile],
"firstName": "xyz789",
"gender": "abc123",
"goals": [UserGoal],
"group": Group,
"groupSessions": [Booking],
"hardSkills": "xyz789",
"hasAvailability": true,
"id": 4,
"instagramLink": "xyz789",
"intercomHash": "abc123",
"invoiceList": InvoiceList,
"isActive": true,
"isMatched": true,
"languages": [Language],
"lastName": "xyz789",
"lastSignInAt": ISO8601DateTime,
"legacyGroup": false,
"linkedinLink": "xyz789",
"location": "xyz789",
"longTermGoals": "abc123",
"managedGroup": ManagedGroup,
"managedGroups": [ManagedGroup],
"market": "xyz789",
"masterclasses": [Booking],
"matchingPercent": 123,
"meetingProvider": "xyz789",
"menteeCapacity": 987,
"menteeMatches": [MentorMatch],
"menteeMatchesRemaining": 987,
"menteeSessionsRemaining": 123,
"mentor": false,
"mentorCapacity": 123,
"mentorMatches": [MentorMatch],
"mentorMatchesRemaining": 987,
"mentorSessionsRemaining": 987,
"mentorlyAdmin": true,
"missingMatchingFields": ["abc123"],
"missingProfileFields": ["xyz789"],
"name": "abc123",
"needsAuth": true,
"needsCalendarConnection": true,
"newProfileImage": UploadedFile,
"newProfileImageUrl": "abc123",
"nextSteps": [NextStep],
"nylasEnabled": true,
"onboarded": false,
"onboardingPercent": 987,
"otpRequiredForLogin": false,
"paymentRequired": true,
"peopleNetwork": ["xyz789"],
"phoneNumber": "xyz789",
"preferredLanguage": Language,
"profileImagePath": "abc123",
"profileImageSettings": ImageSettings,
"profileImageUrl": "xyz789",
"profilePercent": 987,
"pronouns": "abc123",
"publicProfileSegments": [PublicProfileSegment],
"publicTagList": ["abc123"],
"rate30": 987,
"rate60": 987,
"rates": {},
"role": "xyz789",
"sessionLengths": [123],
"sessionsRemaining": 123,
"shortTermGoals": "xyz789",
"signInThrough": "abc123",
"signUpThrough": "abc123",
"skills": "abc123",
"slackConnection": SlackConnection,
"slug": "xyz789",
"socialLinks": [SocialLink],
"softSkills": "abc123",
"status": "xyz789",
"stripeAccount": StripeAccount,
"stripeAccountLink": "xyz789",
"stripeCustomer": StripeCustomer,
"subdisciplineNames": ["abc123"],
"subdisciplines": [Subdiscipline],
"surveyResult": SurveyResult,
"tags": [Tag],
"tier": "xyz789",
"timeSlot": TimeSlot,
"timeSlots": [TimeSlot],
"timezone": "abc123",
"token": "4",
"twitterLink": "abc123",
"uid": 4,
"unconfirmedBookings": [Booking],
"unreadConversationCount": 123,
"userRole": "xyz789",
"vimeoLink": "xyz789",
"website": "abc123",
"welcomeMessage": "abc123",
"workingHours": [WorkingHour],
"youtubeLink": "abc123"
}
DateCount
DeactivateMatchesPayload
Description
Autogenerated return type of DeactivateMatches
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
updatedRecordCount - Int!
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"updatedRecordCount": 987,
"viewer": CurrentUser
}
DeleteAllGroupFilesPayload
Description
Autogenerated return type of DeleteAllGroupFiles
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
groupFiles - [GroupFile!]
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"groupFiles": [GroupFile],
"viewer": CurrentUser
}
DeleteAllUserFilesPayload
Description
Autogenerated return type of DeleteAllUserFiles
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
userFiles - [UserFile!]
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"userFiles": [UserFile],
"viewer": CurrentUser
}
DeleteBookingParticipationPayload
Description
Autogenerated return type of DeleteBookingParticipation
Fields
| Field Name | Description |
|---|---|
booking - Booking
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"booking": Booking,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
DeleteConnectionPayload
Description
Autogenerated return type of DeleteConnection
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
user - ManagedUser
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"user": ManagedUser,
"viewer": CurrentUser
}
DeleteDisciplinePayload
Description
Autogenerated return type of DeleteDiscipline
Fields
| Field Name | Description |
|---|---|
discipline - Discipline
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"discipline": Discipline,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
DeleteGoalProgressNotePayload
Description
Autogenerated return type of DeleteGoalProgressNote
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
goal - UserGoal
|
|
success - Boolean!
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"goal": UserGoal,
"success": false,
"viewer": CurrentUser
}
DeleteGroupFilePayload
Description
Autogenerated return type of DeleteGroupFile
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
groupFile - GroupFile
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"groupFile": GroupFile,
"viewer": CurrentUser
}
DeleteGroupUsersPayload
Description
Autogenerated return type of DeleteGroupUsers
Fields
| Field Name | Description |
|---|---|
deletedUsersCount - Int!
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"deletedUsersCount": 987,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
DeleteMatchPayload
Description
Autogenerated return type of DeleteMatch
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
match - MentorMatch
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"match": MentorMatch,
"viewer": CurrentUser
}
DeleteStripeAccountPayload
Description
Autogenerated return type of DeleteStripeAccount
Fields
| Field Name | Description |
|---|---|
account - StripeAccountDetails
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"account": StripeAccountDetails,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
DeleteStripeCustomerPayload
Description
Autogenerated return type of DeleteStripeCustomer
Fields
| Field Name | Description |
|---|---|
customer - StripeCustomer
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"customer": StripeCustomer,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
DeleteSubdisciplinePayload
Description
Autogenerated return type of DeleteSubdiscipline
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
subdiscipline - Subdiscipline
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"subdiscipline": Subdiscipline,
"viewer": CurrentUser
}
DeleteSurveyQuestionPayload
Description
Autogenerated return type of DeleteSurveyQuestion
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
surveyQuestion - SurveyQuestion
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"surveyQuestion": SurveyQuestion,
"viewer": CurrentUser
}
DeleteTagPayload
Description
Autogenerated return type of DeleteTag
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
tag - Tag
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"tag": Tag,
"viewer": CurrentUser
}
DeleteTimeSlotPayload
Description
Autogenerated return type of DeleteTimeSlot
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
timeSlot - TimeSlot
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"timeSlot": TimeSlot,
"viewer": CurrentUser
}
DeleteUserFilePayload
Description
Autogenerated return type of DeleteUserFile
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
userFile - UserFile
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"userFile": UserFile,
"viewer": CurrentUser
}
DeleteUserGoalPayload
Description
Autogenerated return type of DeleteUserGoal
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
goal - UserGoal
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"goal": UserGoal,
"viewer": CurrentUser
}
DeleteUserPayload
Description
Autogenerated return type of DeleteUser
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
user - ManagedUser
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"user": ManagedUser,
"viewer": CurrentUser
}
Discipline
Example
{
"id": "4",
"imageUrl": "xyz789",
"name": "xyz789",
"slug": "xyz789",
"subdisciplines": [Subdiscipline],
"userCount": 987
}
DisciplineAttributes
DisconnectCalendarAccountPayload
Description
Autogenerated return type of DisconnectCalendarAccount
Fields
| Field Name | Description |
|---|---|
calendarConnection - CalendarConnection
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"calendarConnection": CalendarConnection,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
DisconnectSlackPayload
Description
Autogenerated return type of DisconnectSlack
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
slackConnection - SlackConnection
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"slackConnection": SlackConnection,
"viewer": CurrentUser
}
Discount
Example
{
"cta": "xyz789",
"endTime": ISO8601DateTime,
"id": 4,
"message": "xyz789",
"startTime": ISO8601DateTime
}
EmailContent
Example
{
"action": "abc123",
"audience": "xyz789",
"body": "xyz789",
"id": 4,
"key": 4,
"subject": "abc123"
}
EmergingThemesAnalysis
Fields
| Field Name | Description |
|---|---|
metadata - AnalysisMetadata!
|
Metadata about the analysis including prompt and data used |
summary - String!
|
Summary of the emerging themes analysis |
themes - [Theme!]!
|
List of identified themes |
Example
{
"metadata": AnalysisMetadata,
"summary": "xyz789",
"themes": [Theme]
}
ExtendBookingPayload
Description
Autogenerated return type of ExtendBooking
Fields
| Field Name | Description |
|---|---|
booking - Booking
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"booking": Booking,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
FaqCategories
Fields
| Field Name | Description |
|---|---|
general - [FaqContent!]
|
|
payment - [FaqContent!]
|
|
pricing - [FaqContent!]
|
|
security - [FaqContent!]
|
Example
{
"general": [FaqContent],
"payment": [FaqContent],
"pricing": [FaqContent],
"security": [FaqContent]
}
FaqContent
FeatureContent
Example
{
"id": "4",
"key": "4",
"name": "xyz789",
"plan0": "abc123",
"plan1": "abc123",
"plan2": "abc123",
"planEnterprise": "abc123",
"planPro": "xyz789",
"planStart": "xyz789",
"planTeams": "xyz789"
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
GoalAnalysis
Description
Analysis of goals including themes, insights, and examples
Fields
| Field Name | Description |
|---|---|
examples - [String!]!
|
Representative examples of goals |
insights - [String!]!
|
Actionable insights derived from goals |
themes - [String!]!
|
Common themes identified in goals |
Example
{
"examples": ["xyz789"],
"insights": ["abc123"],
"themes": ["abc123"]
}
GoalProgressNote
Description
Goal progress note
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
goal - UserGoal!
|
|
goalId - ID!
|
|
id - ID!
|
|
noteText - String!
|
|
updatedAt - ISO8601DateTime!
|
|
user - User!
|
Example
{
"createdAt": ISO8601DateTime,
"goal": UserGoal,
"goalId": 4,
"id": 4,
"noteText": "xyz789",
"updatedAt": ISO8601DateTime,
"user": User
}
Group
Description
Public group/program type
Fields
| Field Name | Description |
|---|---|
aboutButtonColor - String
|
|
aboutSubtitle - String
|
|
Arguments
|
|
aboutText - String
|
|
aboutTitle - String
|
|
Arguments
|
|
accentColor - String
|
|
account - Account
|
|
allowGroupSessions - Boolean
|
|
allowMasterclasses - Boolean
|
|
allowedSessionTypes - [SessionTypeEnum!]
|
|
analyticsRestricted - Boolean!
|
Whether analytics features are restricted for this group |
archived - Boolean!
|
|
authProvider - AuthProviderEnum!
|
|
autoAcceptBookingRequests - Boolean
|
|
availabilityCounts - [DateCount!]!
|
|
Arguments
|
|
availabilitySchedule - [AvailabilityDate!]!
|
|
Arguments
|
|
backgroundColor - String
|
|
backgroundImage - GroupFile
|
|
backgroundImages - [GroupFile!]!
|
|
backgroundOpacity - Float
|
|
backgroundOverlayColor - String
|
|
backgroundTextColor - String
|
|
calendarEnabled - Boolean!
|
Whether calendar sync is enabled for this group |
cohorts - [Cohort!]!
|
|
Arguments
|
|
conferenceType - String
|
|
consentText - String
|
|
customDomain - String
|
|
defaultLanguage - String
|
|
defaultProfileImage - GroupFile
|
|
defaultProfileImageUrl - String
|
|
disciplines - [Discipline!]!
|
|
Arguments
|
|
emailFooterImage - GroupFile
|
|
Arguments
|
|
emailHeaderImage - GroupFile
|
|
Arguments
|
|
endsAt - ISO8601DateTime
|
|
fileCategories - [GroupFileCategory!]!
|
|
files - [GroupFile!]!
|
|
fontLink - String
|
|
fontName - String
|
|
goalsEnabled - Boolean!
|
Whether the goals feature is enabled for this group |
groupUrl - String!
|
|
hasIndependentSubdisciplines - Boolean!
|
|
hideMentors - Boolean!
|
|
highlightColor - String
|
|
id - ID!
|
|
independentSubdisciplines - [Subdiscipline!]!
|
|
Arguments
|
|
info - String
|
|
Arguments
|
|
infoSize - Int
|
|
key - ID!
|
|
languages - [Language!]!
|
|
legacy - Boolean!
|
|
locations - [Location!]
|
|
Arguments
|
|
loginUrl - String!
|
|
logoHeader - String
|
|
Arguments
|
|
logoImage - GroupFile
|
|
Arguments
|
|
managers - [User!]
|
|
marketplace - Boolean!
|
|
meetingProvider - String
|
|
member - User
|
|
memberCount - Int!
|
|
members - [User!]!
|
|
membersForSession - [User!]!
|
Returns members with current user's matches prioritized first |
membersForSessionCount - Int!
|
Count of members for session creation |
menteeCapacity - Int
|
|
menteeMaxSessions - Int
|
|
mentorCapacity - Int
|
|
mentorCount - Int!
|
|
mentorDisciplines - [Discipline!]!
|
|
mentorMaxSessions - Int
|
|
mentorMenteeMaxSessions - Int
|
|
mentors - [User!]!
|
|
monthlyBookingParticipationStats - [MonthlyBookingParticipation!]!
|
|
Arguments
|
|
name - String!
|
|
onboardingConfig - OnboardingConfig!
|
Onboarding builder configuration for this group |
otherMembers - [User!]!
|
|
otherMembersCount - Int!
|
|
pageLogoImage - GroupFile
|
|
Arguments
|
|
partnerHeader - String
|
|
Arguments
|
|
partnerInfo - String
|
|
Arguments
|
|
partnerLogoImage - GroupFile
|
|
Arguments
|
|
partnerLogoImages - [GroupFile!]!
|
|
Arguments
|
|
paymentSettings - GroupPaymentSettings
|
|
plan - Plan
|
|
requiresPayment - Boolean!
|
|
segmentsEnabled - Boolean!
|
Whether the segments feature is enabled for this group |
sessionLengths - [Int!]!
|
|
skipOnboarding - Boolean!
|
|
slug - String!
|
|
startsAt - ISO8601DateTime
|
|
styles - GroupStyles
|
|
subtitle - String
|
|
Arguments
|
|
subtitleSize - String
|
|
supporterLogoImages - [GroupFile!]!
|
|
Arguments
|
|
surveyQuestions - [SurveyQuestion!]!
|
|
tag - String!
|
|
tags - [Tag!]!
|
|
Arguments
|
|
terminology - String!
|
Program terminology: 'mentorship' or 'coaching'. Drives mentor/mentee vs coach/client labeling across UI and calendar invites. |
textColor - String
|
|
timeSlots - [TimeSlot!]!
|
|
Arguments
|
|
title - String
|
|
Arguments
|
|
titleFontLink - String
|
|
titleFontName - String
|
|
titleImage - GroupFile
|
|
Arguments
|
|
titleSize - String
|
|
translationStatus - [TranslationStatus!]!
|
|
url - String
|
|
useNylas - Boolean!
|
|
whiteLabel - Boolean!
|
|
Example
{
"aboutButtonColor": "xyz789",
"aboutSubtitle": "abc123",
"aboutText": "xyz789",
"aboutTitle": "abc123",
"accentColor": "abc123",
"account": Account,
"allowGroupSessions": false,
"allowMasterclasses": true,
"allowedSessionTypes": ["groupSession"],
"analyticsRestricted": true,
"archived": true,
"authProvider": "facebook",
"autoAcceptBookingRequests": false,
"availabilityCounts": [DateCount],
"availabilitySchedule": [AvailabilityDate],
"backgroundColor": "xyz789",
"backgroundImage": GroupFile,
"backgroundImages": [GroupFile],
"backgroundOpacity": 123.45,
"backgroundOverlayColor": "xyz789",
"backgroundTextColor": "xyz789",
"calendarEnabled": false,
"cohorts": [Cohort],
"conferenceType": "xyz789",
"consentText": "xyz789",
"customDomain": "xyz789",
"defaultLanguage": "abc123",
"defaultProfileImage": GroupFile,
"defaultProfileImageUrl": "xyz789",
"disciplines": [Discipline],
"emailFooterImage": GroupFile,
"emailHeaderImage": GroupFile,
"endsAt": ISO8601DateTime,
"fileCategories": [GroupFileCategory],
"files": [GroupFile],
"fontLink": "abc123",
"fontName": "abc123",
"goalsEnabled": true,
"groupUrl": "abc123",
"hasIndependentSubdisciplines": true,
"hideMentors": true,
"highlightColor": "abc123",
"id": 4,
"independentSubdisciplines": [Subdiscipline],
"info": "xyz789",
"infoSize": 123,
"key": "4",
"languages": [Language],
"legacy": true,
"locations": [Location],
"loginUrl": "xyz789",
"logoHeader": "xyz789",
"logoImage": GroupFile,
"managers": [User],
"marketplace": true,
"meetingProvider": "abc123",
"member": User,
"memberCount": 123,
"members": [User],
"membersForSession": [User],
"membersForSessionCount": 987,
"menteeCapacity": 987,
"menteeMaxSessions": 987,
"mentorCapacity": 987,
"mentorCount": 987,
"mentorDisciplines": [Discipline],
"mentorMaxSessions": 123,
"mentorMenteeMaxSessions": 123,
"mentors": [User],
"monthlyBookingParticipationStats": [
MonthlyBookingParticipation
],
"name": "abc123",
"onboardingConfig": OnboardingConfig,
"otherMembers": [User],
"otherMembersCount": 123,
"pageLogoImage": GroupFile,
"partnerHeader": "abc123",
"partnerInfo": "xyz789",
"partnerLogoImage": GroupFile,
"partnerLogoImages": [GroupFile],
"paymentSettings": GroupPaymentSettings,
"plan": Plan,
"requiresPayment": true,
"segmentsEnabled": true,
"sessionLengths": [123],
"skipOnboarding": false,
"slug": "xyz789",
"startsAt": ISO8601DateTime,
"styles": GroupStyles,
"subtitle": "abc123",
"subtitleSize": "abc123",
"supporterLogoImages": [GroupFile],
"surveyQuestions": [SurveyQuestion],
"tag": "xyz789",
"tags": [Tag],
"terminology": "abc123",
"textColor": "xyz789",
"timeSlots": [TimeSlot],
"title": "abc123",
"titleFontLink": "abc123",
"titleFontName": "xyz789",
"titleImage": GroupFile,
"titleSize": "abc123",
"translationStatus": [TranslationStatus],
"url": "xyz789",
"useNylas": false,
"whiteLabel": true
}
GroupAttributes
Fields
| Input Field | Description |
|---|---|
aboutButtonColor - String
|
|
aboutText - String
|
|
accentColor - String
|
|
allowGroupSessions - Boolean
|
|
allowMasterclasses - Boolean
|
|
autoAcceptBookingRequests - Boolean
|
|
backgroundColor - String
|
|
backgroundOpacity - Float
|
|
backgroundOverlayColor - String
|
|
backgroundTextColor - String
|
|
billingType - String
|
|
conferenceType - String
|
|
defaultLanguage - String
|
|
enableCohorts - Boolean
|
|
endsAt - ISO8601DateTime
|
|
fontLink - String
|
|
fontName - String
|
|
highlightColor - String
|
|
languages - [String!]
|
|
menteeCapacity - Int
|
|
menteeMaxSessions - Int
|
|
mentorCapacity - Int
|
|
mentorMaxSessions - Int
|
|
mentorMenteeMaxSessions - Int
|
|
name - String
|
|
sessionLengths - [Int!]
|
|
skipOnboarding - Boolean
|
|
slug - String
|
|
startsAt - ISO8601DateTime
|
|
styles - GroupStylesAttributes
|
|
subtitle - String
|
|
subtitleSize - Int
|
|
textColor - String
|
|
title - String
|
|
titleFontLink - String
|
|
titleFontName - String
|
|
titleSize - Int
|
Example
{
"aboutButtonColor": "abc123",
"aboutText": "abc123",
"accentColor": "xyz789",
"allowGroupSessions": false,
"allowMasterclasses": false,
"autoAcceptBookingRequests": true,
"backgroundColor": "xyz789",
"backgroundOpacity": 123.45,
"backgroundOverlayColor": "abc123",
"backgroundTextColor": "xyz789",
"billingType": "abc123",
"conferenceType": "xyz789",
"defaultLanguage": "xyz789",
"enableCohorts": true,
"endsAt": ISO8601DateTime,
"fontLink": "xyz789",
"fontName": "xyz789",
"highlightColor": "abc123",
"languages": ["abc123"],
"menteeCapacity": 123,
"menteeMaxSessions": 123,
"mentorCapacity": 987,
"mentorMaxSessions": 123,
"mentorMenteeMaxSessions": 123,
"name": "abc123",
"sessionLengths": [123],
"skipOnboarding": false,
"slug": "abc123",
"startsAt": ISO8601DateTime,
"styles": GroupStylesAttributes,
"subtitle": "abc123",
"subtitleSize": 123,
"textColor": "abc123",
"title": "abc123",
"titleFontLink": "xyz789",
"titleFontName": "abc123",
"titleSize": 123
}
GroupDashboard
Description
Group dashboard data including group information, review metrics, and user insights
Fields
| Field Name | Description |
|---|---|
groupInfo - JSON!
|
Basic group information and metrics |
reviewSentiment - JSON!
|
Sentiment analysis of reviews |
reviews - JSON!
|
Detailed review data |
surveyAnalytics - JSON!
|
Aggregated analytics from survey responses |
users - JSON!
|
User data with profile and survey information |
Example
{
"groupInfo": {},
"reviewSentiment": {},
"reviews": {},
"surveyAnalytics": {},
"users": {}
}
GroupFile
Description
Group file type
Fields
| Field Name | Description |
|---|---|
customUrl - String
|
|
description - String
|
|
Arguments
|
|
displayHeight - Int
|
|
displayWidth - Int
|
|
fileUrl - String
|
|
height - Int
|
|
id - ID!
|
|
imageUrl - String
|
|
isDownloadable - Boolean!
|
|
key - String!
|
|
mimeType - String
|
|
position - Int
|
|
title - String!
|
|
Arguments
|
|
type - String
|
|
url - String
|
|
width - Int
|
|
Example
{
"customUrl": "abc123",
"description": "xyz789",
"displayHeight": 987,
"displayWidth": 987,
"fileUrl": "abc123",
"height": 987,
"id": "4",
"imageUrl": "abc123",
"isDownloadable": false,
"key": "abc123",
"mimeType": "abc123",
"position": 123,
"title": "xyz789",
"type": "abc123",
"url": "abc123",
"width": 987
}
GroupFileCategory
Description
Group file category type
Fields
| Field Name | Description |
|---|---|
files - [GroupFile!]!
|
|
id - ID!
|
|
name - String!
|
|
Arguments
|
|
Example
{
"files": [GroupFile],
"id": 4,
"name": "abc123"
}
GroupPaymentSettings
Description
Group payment settings
Example
{
"currency": "abc123",
"monthlySubscriptionAmount": 123.45,
"requiresPayment": false,
"signUpFeeAmount": 123.45,
"useSignUpFee": false,
"useSubscriptionFee": false,
"yearlySubscriptionAmount": 123.45
}
GroupPaymentSettingsAttributes
Description
Attributes for updating group payment settings
Example
{
"currency": "xyz789",
"monthlySubscriptionAmount": 123.45,
"requiresPayment": false,
"signUpFeeAmount": 123.45,
"useSignUpFee": true,
"useSubscriptionFee": true,
"yearlySubscriptionAmount": 123.45
}
GroupStyles
Example
{
"accentColor": "xyz789",
"accentTextColor": "xyz789",
"backgroundColor": "xyz789",
"backgroundTextColor": "xyz789",
"fontLink": "xyz789",
"fontName": "xyz789",
"highlightColor": "abc123",
"titleFontLink": "abc123",
"titleFontName": "xyz789"
}
GroupStylesAttributes
Example
{
"accentColor": "abc123",
"accentTextColor": "xyz789",
"backgroundColor": "xyz789",
"backgroundTextColor": "abc123",
"fontLink": "abc123",
"fontName": "abc123",
"highlightColor": "abc123",
"titleFontLink": "abc123",
"titleFontName": "xyz789"
}
HelpArticle
HelpCollection
HelpSection
Fields
| Field Name | Description |
|---|---|
articles - [HelpArticle!]!
|
|
iconUrl - String!
|
|
id - ID!
|
|
name - String!
|
|
url - String!
|
Example
{
"articles": [HelpArticle],
"iconUrl": "abc123",
"id": "4",
"name": "xyz789",
"url": "abc123"
}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
ISO8601Date
Description
An ISO 8601-encoded date
Example
ISO8601Date
ISO8601DateTime
Description
An ISO 8601-encoded datetime
Example
ISO8601DateTime
ImageSettings
ImageSettingsAttributes
ImportCSVFilePayload
Description
Autogenerated return type of ImportCSVFile
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
groupFile - GroupFile
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"groupFile": GroupFile,
"viewer": CurrentUser
}
InitiateCalendarConnectPayload
Description
Autogenerated return type of InitiateCalendarConnect
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
redirectUrl - String
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"redirectUrl": "xyz789",
"viewer": CurrentUser
}
InitiateSlackOauthPayload
Description
Autogenerated return type of InitiateSlackOauth
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
redirectUrl - String
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"redirectUrl": "xyz789",
"viewer": CurrentUser
}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
Invoice
Description
List of invoices
Example
{
"amountPaid": 123,
"created": "xyz789",
"currency": "abc123",
"id": 4,
"invoicePdf": "xyz789",
"number": "abc123",
"status": "xyz789"
}
InvoiceList
Fields
| Field Name | Description |
|---|---|
invoices - [Invoice!]!
|
|
pageInfo - PageInfo!
|
Example
{
"invoices": [Invoice],
"pageInfo": PageInfo
}
JSON
Description
Represents untyped JSON
Example
{}
JobContent
Example
{
"applicationUrl": "xyz789",
"businessFunction": "abc123",
"description": "abc123",
"id": "4",
"jobTitle": "abc123",
"key": 4,
"location": "xyz789",
"seniority": "xyz789"
}
JobStatus
KnowledgeGap
Description
An identified knowledge gap with details and recommendations
Fields
| Field Name | Description |
|---|---|
description - String!
|
Brief description of the gap |
gapLevel - Float!
|
Gap score between 0-10 (0 being the largest gap, 10 being full coverage) |
recommendations - [String!]!
|
Specific recommendations to address the gap |
skill - String!
|
Name of the skill with a gap |
Example
{
"description": "abc123",
"gapLevel": 987.65,
"recommendations": ["abc123"],
"skill": "abc123"
}
KnowledgeGapAnalysis
Description
Analysis of knowledge gaps in a mentorship program
Fields
| Field Name | Description |
|---|---|
gaps - [KnowledgeGap!]!
|
Identified knowledge gaps with details |
metadata - AnalysisMetadata!
|
Metadata about the analysis including prompt used and input data |
rawData - KnowledgeGapRawData
|
Raw data for visualization of knowledge gaps |
summary - String!
|
Brief summary of the overall knowledge gap analysis |
Example
{
"gaps": [KnowledgeGap],
"metadata": AnalysisMetadata,
"rawData": KnowledgeGapRawData,
"summary": "abc123"
}
KnowledgeGapRawData
Description
Raw data for visualization of knowledge gaps between mentor supply and mentee demand
Fields
| Field Name | Description |
|---|---|
knowledgeGaps - [KnowledgeGapRawItem!]
|
Array of knowledge gap items with demand and supply counts |
menteeSkills - SkillCounts
|
Mentee skills aggregated data |
mentorSkills - SkillCounts
|
Mentor skills aggregated data |
Example
{
"knowledgeGaps": [KnowledgeGapRawItem],
"menteeSkills": SkillCounts,
"mentorSkills": SkillCounts
}
KnowledgeGapRawItem
Description
Raw knowledge gap data
Fields
| Field Name | Description |
|---|---|
demandRatio - Float
|
Ratio of mentor supply to mentee demand |
gap - Int!
|
Gap between mentee demand and mentor supply |
gapLevel - Int
|
Calculated gap level between 0-10 (0 being largest gap, 10 being full coverage) |
menteeCount - Int!
|
Number of mentees seeking this skill |
mentorCount - Int!
|
Number of mentors offering this skill |
name - String!
|
Skill name |
significance - Int
|
Total mentions of this skill (indicates importance) |
type - String!
|
Skill type (hard/soft) |
Example
{
"demandRatio": 123.45,
"gap": 987,
"gapLevel": 987,
"menteeCount": 123,
"mentorCount": 123,
"name": "xyz789",
"significance": 987,
"type": "abc123"
}
Language
Location
Fields
| Field Name | Description |
|---|---|
address - String!
|
The full address |
Arguments
|
|
administrativeArea - String
|
The administrative area (state, province) |
Arguments
|
|
country - String
|
|
Arguments
|
|
countryCode - ID
|
|
fullName - String!
|
The combined name and premise |
Arguments
|
|
group - Group!
|
|
id - ID!
|
|
key - String!
|
A unique identifier |
locality - String
|
The locality (city) |
Arguments
|
|
name - String!
|
The name of the location |
Arguments
|
|
postalCode - String
|
The postal code (postal code or zip) |
premise - String
|
The premise (appartment or room number) |
Arguments
|
|
thoroughfare - String
|
The thoroughfare (street) |
Arguments
|
|
Example
{
"address": "xyz789",
"administrativeArea": "xyz789",
"country": "abc123",
"countryCode": "4",
"fullName": "abc123",
"group": Group,
"id": 4,
"key": "xyz789",
"locality": "abc123",
"name": "abc123",
"postalCode": "xyz789",
"premise": "xyz789",
"thoroughfare": "xyz789"
}
ManagedGroup
Description
Managed groups
Fields
| Field Name | Description |
|---|---|
aboutButtonColor - String
|
|
aboutSubtitle - String
|
|
Arguments
|
|
aboutText - String
|
|
aboutTitle - String
|
|
Arguments
|
|
accentColor - String
|
|
account - Account
|
|
allowGroupSessions - Boolean
|
|
allowMasterclasses - Boolean
|
|
allowedSessionTypes - [SessionTypeEnum!]
|
|
analyticsRestricted - Boolean!
|
Whether analytics features are restricted for this group |
archived - Boolean!
|
|
authProvider - AuthProviderEnum!
|
|
autoAcceptBookingRequests - Boolean
|
|
availabilityCounts - [DateCount!]!
|
|
Arguments
|
|
availabilitySchedule - [AvailabilityDate!]!
|
|
Arguments
|
|
averageSessionRating - Float!
|
|
backgroundColor - String
|
|
backgroundImage - GroupFile
|
|
backgroundImages - [GroupFile!]!
|
|
backgroundOpacity - Float
|
|
backgroundOverlayColor - String
|
|
backgroundTextColor - String
|
|
billingType - String
|
|
bookingCount - Int!
|
|
Arguments |
|
bookings - [Booking!]!
|
|
Arguments
|
|
calendarEnabled - Boolean!
|
Whether calendar sync is enabled for this group |
cohorts - [Cohort!]!
|
|
Arguments
|
|
combinedStats - JSON!
|
|
Arguments
|
|
conferenceType - String
|
|
consentText - String
|
|
customDomain - String
|
|
dashboard - GroupDashboard!
|
Comprehensive dashboard data for group analytics and insights |
defaultLanguage - String
|
|
defaultProfileImage - GroupFile
|
|
defaultProfileImageUrl - String
|
|
disciplines - [Discipline!]!
|
|
Arguments
|
|
emailContent - EmailContent
|
|
Arguments
|
|
emailContents - [EmailContent!]!
|
|
emailFooterImage - GroupFile
|
|
Arguments
|
|
emailHeaderImage - GroupFile
|
|
Arguments
|
|
enableCohorts - Boolean
|
|
endsAt - ISO8601DateTime
|
|
fieldStats - JSON!
|
|
Arguments |
|
fileCategories - [GroupFileCategory!]!
|
|
files - [GroupFile!]!
|
|
filteredPoolCount - Int!
|
|
filteredPoolMembers - [ManagedUser!]!
|
|
fontLink - String
|
|
fontName - String
|
|
globalStats - JSON!
|
|
goalsEnabled - Boolean!
|
Whether the goals feature is enabled for this group |
groupUrl - String!
|
|
groupedBookingStats - JSON!
|
|
Arguments
|
|
groupedMemberStats - JSON!
|
|
Arguments
|
|
hasIndependentSubdisciplines - Boolean!
|
|
hideMentors - Boolean!
|
|
highlightColor - String
|
|
id - ID!
|
|
independentSubdisciplines - [Subdiscipline!]!
|
|
Arguments
|
|
info - String
|
|
Arguments
|
|
infoSize - Int
|
|
jobStatus - JobStatus
|
|
Arguments
|
|
jobStatuses - [JobStatus!]!
|
|
Arguments
|
|
key - ID!
|
|
languages - [Language!]!
|
|
legacy - Boolean!
|
|
locations - [Location!]
|
|
Arguments
|
|
loginUrl - String!
|
|
logoHeader - String
|
|
Arguments
|
|
logoImage - GroupFile
|
|
Arguments
|
|
managers - [User!]
|
|
marketplace - Boolean!
|
|
matchCount - Int!
|
|
matchCounts - MatchCounts!
|
|
matches - [MentorMatch!]!
|
|
Arguments |
|
matchingRun - MatchingRun
|
|
Arguments
|
|
matchingRuns - [MatchingRun!]!
|
|
meetingProvider - String
|
|
member - ManagedUser
|
|
memberCount - Int!
|
|
Arguments
|
|
memberStats - [ReportsUser!]!
|
|
Arguments
|
|
memberStatusStats - JSON!
|
|
members - [ManagedUser!]!
|
|
Arguments
|
|
membersForSession - [User!]!
|
Returns members with current user's matches prioritized first |
membersForSessionCount - Int!
|
Count of members for session creation |
menteeCapacity - Int
|
|
menteeMaxSessions - Int
|
|
menteeSessionCountStats - JSON!
|
|
mentorCapacity - Int
|
|
mentorCount - Int!
|
|
mentorCountStats - JSON!
|
|
mentorDisciplines - [Discipline!]!
|
|
mentorMaxSessions - Int
|
|
mentorMenteeMaxSessions - Int
|
|
mentors - [User!]!
|
|
monthRange - JSON!
|
|
monthlyBookingParticipationStats - [MonthlyBookingParticipation!]!
|
|
Arguments
|
|
monthlyStats - JSON!
|
|
name - String!
|
|
onboardingConfig - OnboardingConfig!
|
Onboarding builder configuration for this group |
otherMembers - [User!]!
|
|
otherMembersCount - Int!
|
|
pageLogoImage - GroupFile
|
|
Arguments
|
|
partnerHeader - String
|
|
Arguments
|
|
partnerInfo - String
|
|
Arguments
|
|
partnerLogoImage - GroupFile
|
|
Arguments
|
|
partnerLogoImages - [GroupFile!]!
|
|
Arguments
|
|
paymentSettings - GroupPaymentSettings
|
|
plan - Plan
|
|
requiresPayment - Boolean!
|
|
reviewCount - Int!
|
|
Arguments
|
|
reviews - [Review!]!
|
|
Arguments
|
|
segmentsEnabled - Boolean!
|
Whether the segments feature is enabled for this group |
sessionCount - Int!
|
|
Arguments
|
|
sessionCounts - [DateCount!]!
|
|
Arguments
|
|
sessionLengths - [Int!]!
|
|
sessions - [Booking!]!
|
|
Arguments
|
|
signupStats - JSON!
|
|
skipOnboarding - Boolean!
|
|
slug - String!
|
|
startsAt - ISO8601DateTime
|
|
styles - GroupStyles
|
|
subtitle - String
|
|
Arguments
|
|
subtitleSize - String
|
|
supporterLogoImages - [GroupFile!]!
|
|
Arguments
|
|
surveyQuestions - [SurveyQuestion!]!
|
|
tag - String!
|
|
tags - [Tag!]!
|
|
Arguments
|
|
terminology - String!
|
Program terminology: 'mentorship' or 'coaching'. Drives mentor/mentee vs coach/client labeling across UI and calendar invites. |
textColor - String
|
|
timeSlots - [TimeSlot!]!
|
|
Arguments
|
|
title - String
|
|
Arguments
|
|
titleFontLink - String
|
|
titleFontName - String
|
|
titleImage - GroupFile
|
|
Arguments
|
|
titleSize - String
|
|
translationStatus - [TranslationStatus!]!
|
|
url - String
|
|
useNylas - Boolean!
|
|
whiteLabel - Boolean!
|
|
Example
{
"aboutButtonColor": "abc123",
"aboutSubtitle": "xyz789",
"aboutText": "abc123",
"aboutTitle": "xyz789",
"accentColor": "xyz789",
"account": Account,
"allowGroupSessions": true,
"allowMasterclasses": false,
"allowedSessionTypes": ["groupSession"],
"analyticsRestricted": true,
"archived": false,
"authProvider": "facebook",
"autoAcceptBookingRequests": false,
"availabilityCounts": [DateCount],
"availabilitySchedule": [AvailabilityDate],
"averageSessionRating": 987.65,
"backgroundColor": "xyz789",
"backgroundImage": GroupFile,
"backgroundImages": [GroupFile],
"backgroundOpacity": 987.65,
"backgroundOverlayColor": "abc123",
"backgroundTextColor": "xyz789",
"billingType": "abc123",
"bookingCount": 987,
"bookings": [Booking],
"calendarEnabled": false,
"cohorts": [Cohort],
"combinedStats": {},
"conferenceType": "xyz789",
"consentText": "xyz789",
"customDomain": "xyz789",
"dashboard": GroupDashboard,
"defaultLanguage": "xyz789",
"defaultProfileImage": GroupFile,
"defaultProfileImageUrl": "xyz789",
"disciplines": [Discipline],
"emailContent": EmailContent,
"emailContents": [EmailContent],
"emailFooterImage": GroupFile,
"emailHeaderImage": GroupFile,
"enableCohorts": false,
"endsAt": ISO8601DateTime,
"fieldStats": {},
"fileCategories": [GroupFileCategory],
"files": [GroupFile],
"filteredPoolCount": 123,
"filteredPoolMembers": [ManagedUser],
"fontLink": "abc123",
"fontName": "xyz789",
"globalStats": {},
"goalsEnabled": false,
"groupUrl": "xyz789",
"groupedBookingStats": {},
"groupedMemberStats": {},
"hasIndependentSubdisciplines": false,
"hideMentors": false,
"highlightColor": "abc123",
"id": "4",
"independentSubdisciplines": [Subdiscipline],
"info": "xyz789",
"infoSize": 123,
"jobStatus": JobStatus,
"jobStatuses": [JobStatus],
"key": 4,
"languages": [Language],
"legacy": false,
"locations": [Location],
"loginUrl": "xyz789",
"logoHeader": "xyz789",
"logoImage": GroupFile,
"managers": [User],
"marketplace": false,
"matchCount": 987,
"matchCounts": MatchCounts,
"matches": [MentorMatch],
"matchingRun": MatchingRun,
"matchingRuns": [MatchingRun],
"meetingProvider": "abc123",
"member": ManagedUser,
"memberCount": 123,
"memberStats": [ReportsUser],
"memberStatusStats": {},
"members": [ManagedUser],
"membersForSession": [User],
"membersForSessionCount": 987,
"menteeCapacity": 987,
"menteeMaxSessions": 987,
"menteeSessionCountStats": {},
"mentorCapacity": 123,
"mentorCount": 987,
"mentorCountStats": {},
"mentorDisciplines": [Discipline],
"mentorMaxSessions": 123,
"mentorMenteeMaxSessions": 123,
"mentors": [User],
"monthRange": {},
"monthlyBookingParticipationStats": [
MonthlyBookingParticipation
],
"monthlyStats": {},
"name": "xyz789",
"onboardingConfig": OnboardingConfig,
"otherMembers": [User],
"otherMembersCount": 123,
"pageLogoImage": GroupFile,
"partnerHeader": "abc123",
"partnerInfo": "abc123",
"partnerLogoImage": GroupFile,
"partnerLogoImages": [GroupFile],
"paymentSettings": GroupPaymentSettings,
"plan": Plan,
"requiresPayment": true,
"reviewCount": 987,
"reviews": [Review],
"segmentsEnabled": true,
"sessionCount": 987,
"sessionCounts": [DateCount],
"sessionLengths": [987],
"sessions": [Booking],
"signupStats": {},
"skipOnboarding": false,
"slug": "xyz789",
"startsAt": ISO8601DateTime,
"styles": GroupStyles,
"subtitle": "xyz789",
"subtitleSize": "xyz789",
"supporterLogoImages": [GroupFile],
"surveyQuestions": [SurveyQuestion],
"tag": "xyz789",
"tags": [Tag],
"terminology": "abc123",
"textColor": "abc123",
"timeSlots": [TimeSlot],
"title": "abc123",
"titleFontLink": "abc123",
"titleFontName": "xyz789",
"titleImage": GroupFile,
"titleSize": "abc123",
"translationStatus": [TranslationStatus],
"url": "xyz789",
"useNylas": true,
"whiteLabel": true
}
ManagedUser
Description
Users within groups
Fields
| Field Name | Description |
|---|---|
accounts - [Account!]!
|
|
activated - Boolean!
|
|
activeGoals - [UserGoal!]!
|
|
activeSubscription - Boolean!
|
|
allMatchCount - Int!
|
|
allMatches - [MentorMatch!]!
|
|
allowGroupSessions - Boolean!
|
|
approvedMentor - Boolean!
|
|
archivedAt - ISO8601DateTime
|
|
availabilities - [Availability!]!
|
|
Arguments
|
|
availabilityCounts - [DateCount!]!
|
|
Arguments
|
|
avatar - Avatar!
|
|
behanceLink - String
|
|
bookable - Boolean!
|
|
booking - Booking!
|
|
Arguments
|
|
bookingLink - String
|
|
bookingRequests - [BookingRequest!]!
|
|
Arguments
|
|
bookings - [Booking!]!
|
|
Arguments |
|
calendarId - ID
|
|
calendarProvider - String
|
|
calendarUrl - String
|
|
cancellationPolicy - String!
|
|
cohort - Cohort
|
|
company - String
|
|
completedGoals - [UserGoal!]!
|
|
Arguments
|
|
conference - Conference
|
A conference |
Arguments
|
|
conferences - [Conference!]
|
The current user's conferences |
connections - UserConnections!
|
|
contactEmail - String!
|
|
country - Country
|
|
countryCode - String
|
|
createdUsing - String
|
|
dateOfBirth - ISO8601Date
|
User's date of birth |
description - String
|
|
discipline - Discipline
|
|
disciplineNames - [String!]!
|
|
disciplines - [Discipline!]!
|
|
draftMatchCountAsMentee - Int!
|
Count of staged (draft) matches where this user is the mentee |
dribbbleLink - String
|
|
effectiveMenteeCapacity - Int
|
|
effectiveMentorCapacity - Int
|
|
email - String!
|
|
experience - Int
|
|
extensionNumber - String
|
|
externalId - ID
|
|
facebookLink - String
|
|
featuredMentor - Boolean!
|
|
files - [UserFile!]!
|
|
firstName - String
|
|
gender - String
|
|
goals - [UserGoal!]!
|
|
Arguments
|
|
group - Group
|
|
groupSessions - [Booking!]!
|
|
hardSkills - String
|
|
hasAvailability - Boolean!
|
|
id - ID!
|
|
instagramLink - String
|
|
isActive - Boolean!
|
|
isMatched - Boolean
|
Whether this user is matched with the current user |
languages - [Language!]!
|
|
lastName - String
|
|
lastSignInAt - ISO8601DateTime
|
|
linkedinLink - String
|
|
location - String
|
|
longTermGoals - String
|
|
managedGroup - ManagedGroup
|
|
Arguments
|
|
managedGroups - [ManagedGroup!]!
|
|
market - String
|
|
masterclasses - [Booking!]!
|
|
matchCandidateCount - Int!
|
|
matchCandidates - [MentorMatch!]!
|
|
matches - [MentorMatch!]!
|
|
matchingPercent - Int!
|
|
menteeCapacity - Int
|
|
menteeMatches - [MentorMatch!]!
|
|
menteeMatchesRemaining - Int
|
|
menteeSessionsRemaining - Int
|
|
mentor - Boolean!
|
|
mentorCapacity - Int
|
|
mentorMatches - [MentorMatch!]!
|
|
mentorMatchesRemaining - Int
|
|
mentorSessionsRemaining - Int
|
|
mentorlyAdmin - Boolean
|
|
missingMatchingFields - [String!]!
|
|
missingProfileFields - [String!]!
|
|
name - String!
|
|
newProfileImage - UploadedFile
|
|
newProfileImageUrl - String
|
|
onboarded - Boolean!
|
|
onboardingPercent - Int!
|
|
paymentRequired - Boolean!
|
|
peopleNetwork - [String!]!
|
|
phoneNumber - String
|
|
preferredLanguage - Language!
|
|
profileImagePath - String
|
|
profileImageSettings - ImageSettings!
|
|
profileImageUrl - String
|
|
profilePercent - Int!
|
|
pronouns - String
|
|
publicProfileSegments - [PublicProfileSegment!]!
|
|
Arguments
|
|
publicTagList - [String!]!
|
|
Arguments
|
|
rate30 - Int
|
|
rate60 - Int
|
|
rates - JSON
|
|
role - String
|
|
sessionLengths - [Int!]!
|
|
sessionsRemaining - Int
|
|
shortTermGoals - String
|
|
skills - String
|
|
slug - String
|
|
socialLinks - [SocialLink!]!
|
|
softSkills - String
|
|
status - String!
|
|
subdisciplineNames - [String!]!
|
|
subdisciplines - [Subdiscipline!]!
|
|
surveyResult - SurveyResult
|
|
tags - [Tag!]!
|
|
tier - String
|
|
timeSlot - TimeSlot
|
|
Arguments
|
|
timeSlots - [TimeSlot!]!
|
|
Arguments
|
|
timezone - String
|
|
twitterLink - String
|
|
uid - ID!
|
|
userRole - String!
|
|
vimeoLink - String
|
|
website - String
|
|
welcomeMessage - String
|
|
youtubeLink - String
|
|
Example
{
"accounts": [Account],
"activated": true,
"activeGoals": [UserGoal],
"activeSubscription": false,
"allMatchCount": 123,
"allMatches": [MentorMatch],
"allowGroupSessions": false,
"approvedMentor": false,
"archivedAt": ISO8601DateTime,
"availabilities": [Availability],
"availabilityCounts": [DateCount],
"avatar": Avatar,
"behanceLink": "abc123",
"bookable": false,
"booking": Booking,
"bookingLink": "abc123",
"bookingRequests": [BookingRequest],
"bookings": [Booking],
"calendarId": 4,
"calendarProvider": "abc123",
"calendarUrl": "abc123",
"cancellationPolicy": "xyz789",
"cohort": Cohort,
"company": "xyz789",
"completedGoals": [UserGoal],
"conference": Conference,
"conferences": [Conference],
"connections": UserConnections,
"contactEmail": "abc123",
"country": Country,
"countryCode": "abc123",
"createdUsing": "abc123",
"dateOfBirth": ISO8601Date,
"description": "abc123",
"discipline": Discipline,
"disciplineNames": ["abc123"],
"disciplines": [Discipline],
"draftMatchCountAsMentee": 123,
"dribbbleLink": "abc123",
"effectiveMenteeCapacity": 987,
"effectiveMentorCapacity": 987,
"email": "xyz789",
"experience": 123,
"extensionNumber": "abc123",
"externalId": 4,
"facebookLink": "xyz789",
"featuredMentor": true,
"files": [UserFile],
"firstName": "abc123",
"gender": "abc123",
"goals": [UserGoal],
"group": Group,
"groupSessions": [Booking],
"hardSkills": "xyz789",
"hasAvailability": true,
"id": "4",
"instagramLink": "xyz789",
"isActive": true,
"isMatched": false,
"languages": [Language],
"lastName": "xyz789",
"lastSignInAt": ISO8601DateTime,
"linkedinLink": "abc123",
"location": "abc123",
"longTermGoals": "xyz789",
"managedGroup": ManagedGroup,
"managedGroups": [ManagedGroup],
"market": "abc123",
"masterclasses": [Booking],
"matchCandidateCount": 123,
"matchCandidates": [MentorMatch],
"matches": [MentorMatch],
"matchingPercent": 987,
"menteeCapacity": 123,
"menteeMatches": [MentorMatch],
"menteeMatchesRemaining": 123,
"menteeSessionsRemaining": 987,
"mentor": true,
"mentorCapacity": 987,
"mentorMatches": [MentorMatch],
"mentorMatchesRemaining": 123,
"mentorSessionsRemaining": 987,
"mentorlyAdmin": true,
"missingMatchingFields": ["abc123"],
"missingProfileFields": ["abc123"],
"name": "xyz789",
"newProfileImage": UploadedFile,
"newProfileImageUrl": "abc123",
"onboarded": false,
"onboardingPercent": 123,
"paymentRequired": false,
"peopleNetwork": ["xyz789"],
"phoneNumber": "xyz789",
"preferredLanguage": Language,
"profileImagePath": "xyz789",
"profileImageSettings": ImageSettings,
"profileImageUrl": "abc123",
"profilePercent": 987,
"pronouns": "abc123",
"publicProfileSegments": [PublicProfileSegment],
"publicTagList": ["abc123"],
"rate30": 123,
"rate60": 123,
"rates": {},
"role": "abc123",
"sessionLengths": [123],
"sessionsRemaining": 123,
"shortTermGoals": "xyz789",
"skills": "abc123",
"slug": "abc123",
"socialLinks": [SocialLink],
"softSkills": "xyz789",
"status": "abc123",
"subdisciplineNames": ["abc123"],
"subdisciplines": [Subdiscipline],
"surveyResult": SurveyResult,
"tags": [Tag],
"tier": "xyz789",
"timeSlot": TimeSlot,
"timeSlots": [TimeSlot],
"timezone": "abc123",
"twitterLink": "xyz789",
"uid": 4,
"userRole": "abc123",
"vimeoLink": "xyz789",
"website": "xyz789",
"welcomeMessage": "abc123",
"youtubeLink": "abc123"
}
MatchCounts
MatchSorting
Fields
| Input Field | Description |
|---|---|
activatedAt - SortDirection
|
|
active - SortDirection
|
|
createdAt - SortDirection
|
|
matchingScore - SortDirection
|
|
name - SortDirection
|
|
score - SortDirection
|
Example
{
"activatedAt": "ASC",
"active": "ASC",
"createdAt": "ASC",
"matchingScore": "ASC",
"name": "ASC",
"score": "ASC"
}
MatchingRun
Example
{
"createdAt": ISO8601DateTime,
"id": "4",
"matchesCreated": 987,
"menteeCount": 123,
"menteeFilters": {},
"menteeSlots": 987,
"mentorCount": 987,
"mentorFilters": {},
"mentorMatches": [MentorMatch],
"mentorSlots": 987,
"metadata": {},
"status": "xyz789",
"user": User
}
MemberFilters
Example
{
"archived": false,
"cohort": "xyz789",
"disciplineId": "4",
"experience": "xyz789",
"query": "xyz789",
"segment": "abc123",
"status": "xyz789",
"subdisciplineId": "4",
"tag": "abc123"
}
MemberFiltersAttributes
Example
{
"archived": false,
"cohort": "abc123",
"disciplineId": "4",
"experience": "xyz789",
"query": "abc123",
"segment": "abc123",
"status": "xyz789",
"subdisciplineId": "4",
"tag": "abc123"
}
MemberSorting
Fields
| Input Field | Description |
|---|---|
activatedAt - SortDirection
|
|
active - SortDirection
|
|
createdAt - SortDirection
|
|
matchingScore - SortDirection
|
|
name - SortDirection
|
Example
{
"activatedAt": "ASC",
"active": "ASC",
"createdAt": "ASC",
"matchingScore": "ASC",
"name": "ASC"
}
MentorMatch
Description
A match between users
Fields
| Field Name | Description |
|---|---|
activatedAt - ISO8601DateTime
|
|
active - Boolean!
|
|
deactivatedAt - ISO8601DateTime
|
|
id - ID!
|
|
manual - Boolean!
|
|
matchedAt - ISO8601DateTime!
|
|
mentee - ManagedUser
|
|
mentor - ManagedUser
|
|
responses - [MentorMatchResponse!]!
|
|
score - Float!
|
|
scorePercentage - Float!
|
|
staged - Boolean!
|
|
stagedAt - ISO8601DateTime
|
|
status - MentorMatchStatusEnum!
|
|
updatedAt - ISO8601DateTime
|
Example
{
"activatedAt": ISO8601DateTime,
"active": false,
"deactivatedAt": ISO8601DateTime,
"id": "4",
"manual": true,
"matchedAt": ISO8601DateTime,
"mentee": ManagedUser,
"mentor": ManagedUser,
"responses": [MentorMatchResponse],
"score": 987.65,
"scorePercentage": 123.45,
"staged": false,
"stagedAt": ISO8601DateTime,
"status": "ACTIVATED",
"updatedAt": ISO8601DateTime
}
MentorMatchAttributes
MentorMatchResponse
Fields
| Field Name | Description |
|---|---|
contributesToScore - Boolean!
|
Whether this question is used in score calculation |
id - ID!
|
|
matchingResponse - [String!]!
|
|
maxContribution - Float!
|
Maximum points possible from this question |
menteeResponse - [String!]!
|
The response submitted by the mentee |
mentorResponse - [String!]!
|
The response submitted by the mentor |
question - SurveyQuestion!
|
|
scoreContribution - Float!
|
Points earned from this question |
Example
{
"contributesToScore": true,
"id": 4,
"matchingResponse": ["abc123"],
"maxContribution": 987.65,
"menteeResponse": ["xyz789"],
"mentorResponse": ["abc123"],
"question": SurveyQuestion,
"scoreContribution": 123.45
}
MentorMatchStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVATED"
Message
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
The ID |
text - String!
|
The text of the message |
user - User!
|
Example
{
"createdAt": ISO8601DateTime,
"id": 4,
"text": "xyz789",
"user": User
}
MessageDeletion
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
eventId - ID!
|
|
id - ID!
|
|
user - User!
|
Example
{
"createdAt": ISO8601DateTime,
"eventId": 4,
"id": 4,
"user": User
}
MilestoneContent
Example
{
"id": "4",
"imageUrl": "xyz789",
"key": 4,
"language": "4",
"source": "xyz789",
"text": "xyz789",
"url": "4"
}
MonthlyBookingParticipation
MoveGroupFileHigherPayload
Description
Autogenerated return type of MoveGroupFileHigher
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
groupFile - GroupFile
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"groupFile": GroupFile,
"viewer": CurrentUser
}
MoveGroupFileLowerPayload
Description
Autogenerated return type of MoveGroupFileLower
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
groupFile - GroupFile
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"groupFile": GroupFile,
"viewer": CurrentUser
}
MoveUserFileHigherPayload
Description
Autogenerated return type of MoveUserFileHigher
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
userFile - UserFile
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"userFile": UserFile,
"viewer": CurrentUser
}
MoveUserFileLowerPayload
Description
Autogenerated return type of MoveUserFileLower
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
userFile - UserFile
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"userFile": UserFile,
"viewer": CurrentUser
}
NextStep
Occurrence
Fields
| Field Name | Description |
|---|---|
endTime - ISO8601DateTime!
|
|
startTime - ISO8601DateTime!
|
Example
{
"endTime": ISO8601DateTime,
"startTime": ISO8601DateTime
}
OnboardingConfig
Description
Configuration for the onboarding builder
Fields
| Field Name | Description |
|---|---|
availableComponents - [OnboardingField!]!
|
Component fields (e.g., disciplines) not yet added to onboarding |
availableFields - [OnboardingField!]!
|
Deprecated: use availableSegments instead Use availableSegments instead |
availableSegments - [OnboardingField!]!
|
Public profile segments not yet added to onboarding |
availableSystemFields - [OnboardingField!]!
|
System fields (e.g., email, preferred_language) not yet added to onboarding |
step1Fields - [OnboardingField!]!
|
Fields in Step 1 (Profile & Questions) |
step2Fields - [OnboardingField!]!
|
Fields in Step 2 (Goals & Matching) |
uiStringsTranslations - JSON
|
All onboarding UI string translations keyed by string key, each with locale => text |
Example
{
"availableComponents": [OnboardingField],
"availableFields": [OnboardingField],
"availableSegments": [OnboardingField],
"availableSystemFields": [OnboardingField],
"step1Fields": [OnboardingField],
"step2Fields": [OnboardingField],
"uiStringsTranslations": {}
}
OnboardingField
Description
A field in the onboarding configuration
Fields
| Field Name | Description |
|---|---|
description - String
|
Description for component fields explaining the UI behavior |
inputType - String
|
Input type for system fields: 'text', 'email', 'select', 'textarea' |
key - String!
|
Unique identifier for the field (e.g., 'name', 'pronouns', 'disciplines') |
label - String
|
Display label for the field (default locale) |
labelTranslations - JSON
|
Label translations keyed by locale: { 'en': '...', 'fr': '...' } |
surveyQuestion - SurveyQuestion
|
Associated survey question (for segment fields) |
type - String!
|
Field type: 'system', 'segment', or 'component' |
Example
{
"description": "xyz789",
"inputType": "abc123",
"key": "abc123",
"label": "xyz789",
"labelTranslations": {},
"surveyQuestion": SurveyQuestion,
"type": "xyz789"
}
OnboardingFieldInput
PageContent
Example
{
"body": "abc123",
"bodyHtml": "abc123",
"description": "abc123",
"id": "4",
"key": 4,
"publishedAt": ISO8601DateTime,
"title": "abc123",
"updatedAt": ISO8601DateTime
}
PageInfo
PartnerContent
Example
{
"id": 4,
"imageUrl": "xyz789",
"key": "4",
"name": "xyz789",
"url": "abc123"
}
Plan
PlanContent
Example
{
"description": "abc123",
"id": "4",
"key": "4",
"mainFeatures": "xyz789",
"name": "xyz789",
"price": "xyz789",
"users": "abc123"
}
PreviewMatchingPayload
Description
Autogenerated return type of PreviewMatching
Fields
| Field Name | Description |
|---|---|
averageScore - Float
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
matchingRunId - ID
|
|
menteeCount - Int
|
|
mentorCount - Int
|
|
proposedMatches - [ProposedMatch!]
|
|
viewer - CurrentUser
|
|
warnings - [String!]
|
Example
{
"averageScore": 123.45,
"errorDetails": {},
"errors": ["abc123"],
"matchingRunId": 4,
"menteeCount": 123,
"mentorCount": 123,
"proposedMatches": [ProposedMatch],
"viewer": CurrentUser,
"warnings": ["abc123"]
}
ProposedMatch
Fields
| Field Name | Description |
|---|---|
matchingSkills - [String!]!
|
|
mentee - User!
|
|
mentor - User!
|
|
responses - [MentorMatchResponse!]!
|
|
score - Float!
|
|
scorePercentage - Float!
|
|
warnings - [String!]!
|
Example
{
"matchingSkills": ["abc123"],
"mentee": User,
"mentor": User,
"responses": [MentorMatchResponse],
"score": 123.45,
"scorePercentage": 987.65,
"warnings": ["xyz789"]
}
PublicProfileSegment
RegisterAccountUserPayload
Description
Autogenerated return type of RegisterAccountUser
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
loginUrl - String
|
|
user - CurrentUser
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"loginUrl": "abc123",
"user": CurrentUser,
"viewer": CurrentUser
}
RegisterUserPayload
Description
Autogenerated return type of RegisterUser
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
loginUrl - String
|
|
user - CurrentUser
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"loginUrl": "abc123",
"user": CurrentUser,
"viewer": CurrentUser
}
RejectBookingRequestPayload
Description
Autogenerated return type of RejectBookingRequest
Fields
| Field Name | Description |
|---|---|
bookingRequest - BookingRequest
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"bookingRequest": BookingRequest,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
RemoveAuthenticatorPayload
Description
Autogenerated return type of RemoveAuthenticator
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
user - CurrentUser
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"user": CurrentUser,
"viewer": CurrentUser
}
RemoveZoomConnectionPayload
Description
Autogenerated return type of RemoveZoomConnection
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
ReportsUser
Example
{
"acceptedSessions": 123,
"acceptedSessionsDuration": 123,
"acceptedSessionsHours": "abc123",
"availabilitiesAdded": "xyz789",
"id": 4,
"name": "xyz789",
"totalAvailabilityDuration": 123,
"totalAvailabilityHours": "xyz789"
}
ReportsUserSorting
Fields
| Input Field | Description |
|---|---|
acceptedSessions - SortDirection
|
|
id - SortDirection
|
|
name - SortDirection
|
Example
{"acceptedSessions": "ASC", "id": "ASC", "name": "ASC"}
RequestPasswordResetPayload
Description
Autogenerated return type of RequestPasswordReset
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
status - String
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"status": "xyz789",
"viewer": CurrentUser
}
ResetPasswordPayload
Description
Autogenerated return type of ResetPassword
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
user - CurrentUser
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"user": CurrentUser,
"viewer": CurrentUser
}
Review
Example
{
"booking": Booking,
"id": "4",
"noShow": false,
"otherDetails": "abc123",
"platformRating": 123,
"platformRatingDetails": "abc123",
"platformRatingReason": "abc123",
"role": "xyz789",
"sessionRating": 987,
"sessionRatingDetails": "xyz789",
"sessionRatingReason": "xyz789",
"user": User
}
ReviewAttributes
Example
{
"bookingId": 4,
"noShow": false,
"otherDetails": "xyz789",
"platformRating": 987,
"platformRatingDetails": "abc123",
"platformRatingReason": "abc123",
"role": "abc123",
"sessionRating": 987,
"sessionRatingDetails": "xyz789",
"sessionRatingReason": "xyz789"
}
ReviewSentiment
Fields
| Field Name | Description |
|---|---|
negativeThemes - [ReviewTheme!]!
|
Recurring negative themes from reviews |
neutralThemes - [ReviewTheme!]!
|
Recurring neutral themes from reviews |
positiveThemes - [ReviewTheme!]!
|
Recurring positive themes from reviews |
sentimentSummary - String!
|
Summary of the overall sentiment from reviews |
Example
{
"negativeThemes": [ReviewTheme],
"neutralThemes": [ReviewTheme],
"positiveThemes": [ReviewTheme],
"sentimentSummary": "xyz789"
}
ReviewSorting
Fields
| Input Field | Description |
|---|---|
createdAt - SortDirection
|
|
sessionRating - SortDirection
|
Example
{"createdAt": "ASC", "sessionRating": "ASC"}
ReviewTheme
Fields
| Field Name | Description |
|---|---|
description - String!
|
Description of the theme |
example - ReviewThemeExample!
|
Example review that illustrates this theme |
theme - String!
|
Name of the recurring theme |
Example
{
"description": "abc123",
"example": ReviewThemeExample,
"theme": "xyz789"
}
ReviewThemeExample
RevokeApiKeyPayload
Description
Autogenerated return type of RevokeApiKey
Fields
| Field Name | Description |
|---|---|
apiKey - ApiKey
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"apiKey": ApiKey,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
RotateApiKeyPayload
Description
Autogenerated return type of RotateApiKey
Fields
| Field Name | Description |
|---|---|
apiKey - ApiKey
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
plaintextToken - String
|
The new key's full token. Returned ONCE. |
viewer - CurrentUser
|
Example
{
"apiKey": ApiKey,
"errorDetails": {},
"errors": ["abc123"],
"plaintextToken": "abc123",
"viewer": CurrentUser
}
RunAutomaticMatchingPayload
Description
Autogenerated return type of RunAutomaticMatching
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
status - JobStatus
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"status": JobStatus,
"viewer": CurrentUser
}
SendOnboardingEmailPayload
Description
Autogenerated return type of SendOnboardingEmail
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
status - String
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"status": "xyz789",
"viewer": CurrentUser
}
SendPendingInvitationEmailsPayload
Description
Autogenerated return type of SendPendingInvitationEmails
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
status - String
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"status": "xyz789",
"viewer": CurrentUser
}
SessionTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"groupSession"
SkillCount
SkillCounts
Description
Skill counts by type
Fields
| Field Name | Description |
|---|---|
hardSkills - [SkillCount!]
|
Hard skills counts |
softSkills - [SkillCount!]
|
Soft skills counts |
Example
{
"hardSkills": [SkillCount],
"softSkills": [SkillCount]
}
SlackConnection
Description
Slack notification settings for the current user
Fields
| Field Name | Description |
|---|---|
availableForGroup - Boolean!
|
True if the user's group has an active Slack workspace |
isConnected - Boolean!
|
True if the user has an active SlackUserMapping in their workspace |
notificationPreference - String
|
One of: slack, email |
slackEmail - String
|
Email under which the user is registered in Slack |
slackUserId - String
|
|
timezone - String
|
Slack-reported timezone (used to format DM timestamps) |
workspaceTeamId - String
|
|
workspaceTeamName - String
|
Example
{
"availableForGroup": true,
"isConnected": false,
"notificationPreference": "abc123",
"slackEmail": "xyz789",
"slackUserId": "xyz789",
"timezone": "xyz789",
"workspaceTeamId": "abc123",
"workspaceTeamName": "abc123"
}
SocialConnection
Values
| Enum Value | Description |
|---|---|
|
|
Google connection |
|
|
Microsoft connection |
Example
"google"
SocialLink
SortDirection
Values
| Enum Value | Description |
|---|---|
|
|
Sort by ascending order |
|
|
Sort by descending order |
Example
"ASC"
StageMatchesPayload
Description
Autogenerated return type of StageMatches
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
updatedRecordCount - Int!
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"updatedRecordCount": 123,
"viewer": CurrentUser
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
StripeAccount
Description
A stripe account
Fields
| Field Name | Description |
|---|---|
accountLink - String
|
|
dashboardLink - String
|
|
id - String!
|
|
products - [StripeProduct!]!
|
Example
{
"accountLink": "xyz789",
"dashboardLink": "xyz789",
"id": "abc123",
"products": [StripeProduct]
}
StripeAccountCreateAttributes
Example
{
"address": "abc123",
"bankTokenId": "4",
"city": "abc123",
"country": "abc123",
"dateOfBirth": ISO8601DateTime,
"identityTokenId": "4",
"phone": "xyz789",
"postalCode": "abc123",
"state": "xyz789",
"url": "xyz789"
}
StripeAccountDetails
StripeAccountUpdateAttributes
Fields
| Input Field | Description |
|---|---|
bankTokenId - ID!
|
|
dateOfBirth - ISO8601DateTime!
|
|
phone - String!
|
|
url - String!
|
Example
{
"bankTokenId": "4",
"dateOfBirth": ISO8601DateTime,
"phone": "abc123",
"url": "abc123"
}
StripeCustomer
StripeProduct
Description
A stripe product
Example
{
"active": true,
"amount": 123.45,
"currency": "xyz789",
"defaultPrice": "xyz789",
"id": "abc123",
"name": "abc123",
"priceId": 4,
"type": "xyz789"
}
Subdiscipline
SubdisciplineAttributes
SurveyQuestion
Fields
| Field Name | Description |
|---|---|
answerKeys - [String!]
|
|
answers - [String!]
|
|
Arguments
|
|
answersTranslations - JSON
|
|
calculate - Boolean
|
|
choiceLimit - Int
|
|
Arguments
|
|
id - ID!
|
|
idealOverlap - Int
|
|
instructions - String
|
|
Arguments
|
|
instructionsTranslations - JSON
|
|
key - String!
|
|
label - String
|
|
Arguments
|
|
labelTranslations - JSON
|
|
menteeChoiceLimit - Int
|
|
menteeQuestionTranslations - JSON
|
|
mentorChoiceLimit - Int
|
|
mentorQuestionTranslations - JSON
|
|
position - Int!
|
|
profile - Boolean
|
|
question - String
|
|
Arguments
|
|
questionType - String!
|
|
required - String
|
|
segmentType - String!
|
|
showInPublicProfile - Boolean!
|
|
useForMatching - Boolean!
|
|
weight - Float
|
|
Example
{
"answerKeys": ["xyz789"],
"answers": ["abc123"],
"answersTranslations": {},
"calculate": true,
"choiceLimit": 123,
"id": "4",
"idealOverlap": 987,
"instructions": "abc123",
"instructionsTranslations": {},
"key": "xyz789",
"label": "xyz789",
"labelTranslations": {},
"menteeChoiceLimit": 123,
"menteeQuestionTranslations": {},
"mentorChoiceLimit": 123,
"mentorQuestionTranslations": {},
"position": 123,
"profile": false,
"question": "abc123",
"questionType": "abc123",
"required": "xyz789",
"segmentType": "abc123",
"showInPublicProfile": false,
"useForMatching": false,
"weight": 123.45
}
SurveyQuestionAttributes
Fields
| Input Field | Description |
|---|---|
answers - JSON
|
|
calculate - Boolean
|
|
groupId - ID
|
|
idealOverlap - Int
|
|
instructions - JSON
|
|
key - String
|
|
label - JSON
|
|
menteeChoiceLimit - Int
|
|
menteeQuestion - JSON
|
|
mentorChoiceLimit - Int
|
|
mentorQuestion - JSON
|
|
position - Int
|
|
profile - Boolean
|
|
questionType - String
|
|
required - String
|
|
searchable - Boolean
|
|
segmentType - String
|
|
showInPublicProfile - Boolean
|
|
useForMatching - Boolean
|
|
weight - Float
|
Example
{
"answers": {},
"calculate": true,
"groupId": 4,
"idealOverlap": 987,
"instructions": {},
"key": "abc123",
"label": {},
"menteeChoiceLimit": 987,
"menteeQuestion": {},
"mentorChoiceLimit": 987,
"mentorQuestion": {},
"position": 123,
"profile": false,
"questionType": "xyz789",
"required": "abc123",
"searchable": false,
"segmentType": "abc123",
"showInPublicProfile": true,
"useForMatching": false,
"weight": 123.45
}
SurveyResult
Tag
TagAttributes
TeamCategories
Fields
| Field Name | Description |
|---|---|
advisors - [TeamContent!]
|
|
founders - [TeamContent!]
|
Example
{
"advisors": [TeamContent],
"founders": [TeamContent]
}
TeamContent
Example
{
"id": "4",
"imageUrl": "abc123",
"key": "4",
"name": "abc123",
"position": 987,
"title": "abc123",
"url": "xyz789"
}
TestimonialContent
Example
{
"body": "xyz789",
"category": "xyz789",
"id": 4,
"imageUrl": "xyz789",
"key": 4,
"name": "abc123"
}
Theme
Fields
| Field Name | Description |
|---|---|
description - String!
|
Description of the theme |
importance - Float!
|
Importance score (1-10) of the theme |
recommendations - [String!]!
|
Recommendations related to this theme |
supportingData - [String!]!
|
Supporting data points for this theme |
title - String!
|
Title of the emerging theme |
Example
{
"description": "abc123",
"importance": 123.45,
"recommendations": ["xyz789"],
"supportingData": ["abc123"],
"title": "abc123"
}
TimeSlot
Fields
| Field Name | Description |
|---|---|
allowGroupSessions - Boolean!
|
|
endTime - ISO8601DateTime!
|
|
id - ID!
|
The ID |
location - Location
|
|
occurrences - [Occurrence!]!
|
|
Arguments
|
|
readOnly - Boolean!
|
|
recurringWeekly - Boolean!
|
|
startTime - ISO8601DateTime!
|
|
user - User!
|
|
Example
{
"allowGroupSessions": false,
"endTime": ISO8601DateTime,
"id": "4",
"location": Location,
"occurrences": [Occurrence],
"readOnly": true,
"recurringWeekly": true,
"startTime": ISO8601DateTime,
"user": User
}
TimeSlotAttributes
Fields
| Input Field | Description |
|---|---|
endTime - ISO8601DateTime!
|
|
locationId - ID
|
|
recurringWeekly - Boolean
|
|
startTime - ISO8601DateTime!
|
Example
{
"endTime": ISO8601DateTime,
"locationId": "4",
"recurringWeekly": true,
"startTime": ISO8601DateTime
}
TranslationInput
TranslationStatus
Description
Translation completeness status for a language
Example
{
"language": Language,
"locale": "abc123",
"missing": 987,
"percentage": 987,
"total": 123,
"translated": 123
}
UnarchiveGroupUsersPayload
Description
Autogenerated return type of UnarchiveGroupUsers
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
unarchivedUsersCount - Int!
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"unarchivedUsersCount": 987,
"viewer": CurrentUser
}
UnarchiveUserPayload
Description
Autogenerated return type of UnarchiveUser
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
user - ManagedUser
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"user": ManagedUser,
"viewer": CurrentUser
}
UncompleteUserGoalPayload
Description
Autogenerated return type of UncompleteUserGoal
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
goal - UserGoal
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"goal": UserGoal,
"viewer": CurrentUser
}
UpdateBookingPayload
Description
Autogenerated return type of UpdateBooking
Fields
| Field Name | Description |
|---|---|
booking - Booking
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"booking": Booking,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
UpdateCalendarConfigurationPayload
Description
Autogenerated return type of UpdateCalendarConfiguration
Fields
| Field Name | Description |
|---|---|
calendarConnection - CalendarConnection
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"calendarConnection": CalendarConnection,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
UpdateCohortPayload
Description
Autogenerated return type of UpdateCohort
Fields
| Field Name | Description |
|---|---|
cohort - Cohort
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"cohort": Cohort,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
UpdateConversationTitlePayload
Description
Autogenerated return type of UpdateConversationTitle
Fields
| Field Name | Description |
|---|---|
conversation - Conversation!
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"conversation": Conversation,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
UpdateDisciplinePayload
Description
Autogenerated return type of UpdateDiscipline
Fields
| Field Name | Description |
|---|---|
discipline - Discipline!
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"discipline": Discipline,
"errorDetails": {},
"errors": ["xyz789"],
"viewer": CurrentUser
}
UpdateGoalProgressNotePayload
Description
Autogenerated return type of UpdateGoalProgressNote
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
goal - UserGoal
|
|
progressNote - GoalProgressNote
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"goal": UserGoal,
"progressNote": GoalProgressNote,
"viewer": CurrentUser
}
UpdateGroupFilePayload
Description
Autogenerated return type of UpdateGroupFile
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
groupFile - GroupFile
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"groupFile": GroupFile,
"viewer": CurrentUser
}
UpdateGroupPayload
Description
Autogenerated return type of UpdateGroup
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
managedGroup - ManagedGroup
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"managedGroup": ManagedGroup,
"viewer": CurrentUser
}
UpdateGroupPaymentSettingsPayload
Description
Autogenerated return type of UpdateGroupPaymentSettings
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
managedGroup - ManagedGroup
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"managedGroup": ManagedGroup,
"viewer": CurrentUser
}
UpdateGroupStylesPayload
Description
Autogenerated return type of UpdateGroupStyles
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
managedGroup - ManagedGroup
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"managedGroup": ManagedGroup,
"viewer": CurrentUser
}
UpdateGroupUsersPayload
Description
Autogenerated return type of UpdateGroupUsers
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
updatedUsersCount - Int!
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"updatedUsersCount": 987,
"viewer": CurrentUser
}
UpdateMatchPayload
Description
Autogenerated return type of UpdateMatch
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
match - MentorMatch
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"match": MentorMatch,
"viewer": CurrentUser
}
UpdateOnboardingConfigPayload
Description
Autogenerated return type of UpdateOnboardingConfig
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
onboardingConfig - OnboardingConfig
|
The updated onboarding configuration |
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"onboardingConfig": OnboardingConfig,
"viewer": CurrentUser
}
UpdatePasswordPayload
Description
Autogenerated return type of UpdatePassword
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
user - CurrentUser
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"user": CurrentUser,
"viewer": CurrentUser
}
UpdateSlackNotificationPreferencePayload
Description
Autogenerated return type of UpdateSlackNotificationPreference
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
slackConnection - SlackConnection
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"slackConnection": SlackConnection,
"viewer": CurrentUser
}
UpdateStripeAccountPayload
Description
Autogenerated return type of UpdateStripeAccount
Fields
| Field Name | Description |
|---|---|
account - StripeAccountDetails
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"account": StripeAccountDetails,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
UpdateStripeCustomerPayload
Description
Autogenerated return type of UpdateStripeCustomer
Fields
| Field Name | Description |
|---|---|
customer - StripeCustomer
|
|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
Example
{
"customer": StripeCustomer,
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser
}
UpdateSubdisciplinePayload
Description
Autogenerated return type of UpdateSubdiscipline
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
subdiscipline - Subdiscipline!
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"subdiscipline": Subdiscipline,
"viewer": CurrentUser
}
UpdateSurveyQuestionPayload
Description
Autogenerated return type of UpdateSurveyQuestion
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
surveyQuestion - SurveyQuestion
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"surveyQuestion": SurveyQuestion,
"viewer": CurrentUser
}
UpdateTagPayload
Description
Autogenerated return type of UpdateTag
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
tag - Tag
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"tag": Tag,
"viewer": CurrentUser
}
UpdateTimeSlotPayload
Description
Autogenerated return type of UpdateTimeSlot
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
timeSlot - TimeSlot
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"timeSlot": TimeSlot,
"viewer": CurrentUser
}
UpdateTranslationsPayload
Description
Autogenerated return type of UpdateTranslations
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
surveyQuestions - [SurveyQuestion!]
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"surveyQuestions": [SurveyQuestion],
"viewer": CurrentUser
}
UpdateUserFilePayload
Description
Autogenerated return type of UpdateUserFile
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
userFile - UserFile
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"userFile": UserFile,
"viewer": CurrentUser
}
UpdateUserGoalPayload
Description
Autogenerated return type of UpdateUserGoal
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
goal - UserGoal
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"goal": UserGoal,
"viewer": CurrentUser
}
UpdateUserPayload
Description
Autogenerated return type of UpdateUser
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
user - ManagedUser
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"user": ManagedUser,
"viewer": CurrentUser
}
UpdateWorkingHoursPayload
Description
Autogenerated return type of UpdateWorkingHours
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
viewer - CurrentUser
|
|
workingHours - [WorkingHour!]!
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"viewer": CurrentUser,
"workingHours": [WorkingHour]
}
Upload
UploadAttributes
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
metadata - UploadMetadataAttributes!
|
|
storage - String
|
Example
{
"id": "4",
"metadata": UploadMetadataAttributes,
"storage": "xyz789"
}
UploadMetadataAttributes
UploadedFile
UseCaseCategories
Fields
| Field Name | Description |
|---|---|
communities - [UseCaseContent!]
|
|
networks - [UseCaseContent!]
|
|
schools - [UseCaseContent!]
|
|
specialProgramming - [UseCaseContent!]
|
Example
{
"communities": [UseCaseContent],
"networks": [UseCaseContent],
"schools": [UseCaseContent],
"specialProgramming": [UseCaseContent]
}
UseCaseContent
Fields
| Field Name | Description |
|---|---|
body - String
|
|
category - String!
|
|
embedCode - String
|
|
Arguments
|
|
id - ID!
|
|
key - ID!
|
|
name - String
|
|
Arguments
|
|
organization - String
|
|
Arguments
|
|
position - Int
|
|
quote - TestimonialContent
|
|
videoUrl - String
|
|
Arguments
|
|
Example
{
"body": "abc123",
"category": "xyz789",
"embedCode": "abc123",
"id": "4",
"key": 4,
"name": "xyz789",
"organization": "xyz789",
"position": 987,
"quote": TestimonialContent,
"videoUrl": "xyz789"
}
User
Description
Public user type
Fields
| Field Name | Description |
|---|---|
accounts - [Account!]!
|
|
activeGoals - [UserGoal!]!
|
|
activeSubscription - Boolean!
|
|
allowGroupSessions - Boolean!
|
|
availabilities - [Availability!]!
|
|
Arguments
|
|
availabilityCounts - [DateCount!]!
|
|
Arguments
|
|
avatar - Avatar!
|
|
behanceLink - String
|
|
bookable - Boolean!
|
|
bookingLink - String
|
|
bookings - [Booking!]!
|
|
Arguments
|
|
cancellationPolicy - String!
|
|
cohort - Cohort
|
|
company - String
|
|
completedGoals - [UserGoal!]!
|
|
Arguments
|
|
country - Country
|
|
countryCode - String
|
|
createdUsing - String
|
|
description - String
|
|
discipline - Discipline
|
|
disciplineNames - [String!]!
|
|
disciplines - [Discipline!]!
|
|
dribbbleLink - String
|
|
effectiveMenteeCapacity - Int
|
|
effectiveMentorCapacity - Int
|
|
experience - Int
|
|
facebookLink - String
|
|
files - [UserFile!]!
|
|
firstName - String
|
|
goals - [UserGoal!]!
|
|
Arguments
|
|
group - Group
|
|
groupSessions - [Booking!]!
|
|
hardSkills - String
|
|
hasAvailability - Boolean!
|
|
id - ID!
|
|
instagramLink - String
|
|
isActive - Boolean!
|
|
isMatched - Boolean
|
Whether this user is matched with the current user |
languages - [Language!]!
|
|
lastName - String
|
|
lastSignInAt - ISO8601DateTime
|
|
linkedinLink - String
|
|
location - String
|
|
longTermGoals - String
|
|
market - String
|
|
masterclasses - [Booking!]!
|
|
matchingPercent - Int!
|
|
menteeCapacity - Int
|
|
menteeMatchesRemaining - Int
|
|
menteeSessionsRemaining - Int
|
|
mentor - Boolean!
|
|
mentorCapacity - Int
|
|
mentorMatchesRemaining - Int
|
|
mentorSessionsRemaining - Int
|
|
mentorlyAdmin - Boolean
|
|
missingMatchingFields - [String!]!
|
|
missingProfileFields - [String!]!
|
|
name - String!
|
|
newProfileImage - UploadedFile
|
|
newProfileImageUrl - String
|
|
onboardingPercent - Int!
|
|
paymentRequired - Boolean!
|
|
peopleNetwork - [String!]!
|
|
preferredLanguage - Language!
|
|
profileImagePath - String
|
|
profileImageSettings - ImageSettings!
|
|
profileImageUrl - String
|
|
profilePercent - Int!
|
|
pronouns - String
|
|
publicProfileSegments - [PublicProfileSegment!]!
|
|
Arguments
|
|
publicTagList - [String!]!
|
|
Arguments
|
|
rate30 - Int
|
|
rate60 - Int
|
|
rates - JSON
|
|
role - String
|
|
sessionLengths - [Int!]!
|
|
sessionsRemaining - Int
|
|
shortTermGoals - String
|
|
skills - String
|
|
slug - String
|
|
socialLinks - [SocialLink!]!
|
|
softSkills - String
|
|
status - String!
|
|
subdisciplineNames - [String!]!
|
|
subdisciplines - [Subdiscipline!]!
|
|
tags - [Tag!]!
|
|
tier - String
|
|
timeSlot - TimeSlot
|
|
Arguments
|
|
timeSlots - [TimeSlot!]!
|
|
Arguments
|
|
timezone - String
|
|
twitterLink - String
|
|
uid - ID!
|
|
userRole - String!
|
|
vimeoLink - String
|
|
website - String
|
|
welcomeMessage - String
|
|
youtubeLink - String
|
|
Example
{
"accounts": [Account],
"activeGoals": [UserGoal],
"activeSubscription": false,
"allowGroupSessions": true,
"availabilities": [Availability],
"availabilityCounts": [DateCount],
"avatar": Avatar,
"behanceLink": "abc123",
"bookable": false,
"bookingLink": "abc123",
"bookings": [Booking],
"cancellationPolicy": "abc123",
"cohort": Cohort,
"company": "abc123",
"completedGoals": [UserGoal],
"country": Country,
"countryCode": "abc123",
"createdUsing": "xyz789",
"description": "abc123",
"discipline": Discipline,
"disciplineNames": ["xyz789"],
"disciplines": [Discipline],
"dribbbleLink": "xyz789",
"effectiveMenteeCapacity": 123,
"effectiveMentorCapacity": 123,
"experience": 123,
"facebookLink": "xyz789",
"files": [UserFile],
"firstName": "xyz789",
"goals": [UserGoal],
"group": Group,
"groupSessions": [Booking],
"hardSkills": "xyz789",
"hasAvailability": true,
"id": "4",
"instagramLink": "abc123",
"isActive": false,
"isMatched": false,
"languages": [Language],
"lastName": "abc123",
"lastSignInAt": ISO8601DateTime,
"linkedinLink": "abc123",
"location": "abc123",
"longTermGoals": "xyz789",
"market": "xyz789",
"masterclasses": [Booking],
"matchingPercent": 123,
"menteeCapacity": 123,
"menteeMatchesRemaining": 123,
"menteeSessionsRemaining": 123,
"mentor": true,
"mentorCapacity": 123,
"mentorMatchesRemaining": 123,
"mentorSessionsRemaining": 123,
"mentorlyAdmin": false,
"missingMatchingFields": ["xyz789"],
"missingProfileFields": ["xyz789"],
"name": "xyz789",
"newProfileImage": UploadedFile,
"newProfileImageUrl": "xyz789",
"onboardingPercent": 123,
"paymentRequired": true,
"peopleNetwork": ["xyz789"],
"preferredLanguage": Language,
"profileImagePath": "xyz789",
"profileImageSettings": ImageSettings,
"profileImageUrl": "abc123",
"profilePercent": 987,
"pronouns": "xyz789",
"publicProfileSegments": [PublicProfileSegment],
"publicTagList": ["xyz789"],
"rate30": 987,
"rate60": 123,
"rates": {},
"role": "abc123",
"sessionLengths": [987],
"sessionsRemaining": 987,
"shortTermGoals": "abc123",
"skills": "xyz789",
"slug": "abc123",
"socialLinks": [SocialLink],
"softSkills": "abc123",
"status": "xyz789",
"subdisciplineNames": ["abc123"],
"subdisciplines": [Subdiscipline],
"tags": [Tag],
"tier": "xyz789",
"timeSlot": TimeSlot,
"timeSlots": [TimeSlot],
"timezone": "abc123",
"twitterLink": "xyz789",
"uid": 4,
"userRole": "abc123",
"vimeoLink": "abc123",
"website": "abc123",
"welcomeMessage": "abc123",
"youtubeLink": "abc123"
}
UserAttributes
Description
Input attributes for users
Fields
| Input Field | Description |
|---|---|
activated - Boolean
|
|
allowGroupSessions - Boolean
|
|
approvedMentor - Boolean
|
|
availabilityCalendarId - ID
|
|
behanceLink - String
|
|
bookingLink - String
|
|
calendarId - ID
|
|
calendarProvider - String
|
|
calendarUrl - String
|
|
cancellationPolicy - String
|
|
cohortId - ID
|
|
company - String
|
|
contactEmail - String
|
|
countryCode - String
|
|
dateOfBirth - ISO8601Date
|
|
description - String
|
|
disciplineId - ID
|
|
disciplineIds - [ID!]
|
|
dribbbleLink - String
|
|
email - String
|
|
experience - Int
|
|
extensionNumber - String
|
|
externalId - ID
|
|
facebookLink - String
|
|
featuredMentor - Boolean
|
|
hardSkills - String
|
|
instagramLink - String
|
|
languageCodes - [String!]
|
|
linkedinLink - String
|
|
location - String
|
|
longTermGoals - String
|
|
market - String
|
|
menteeCapacity - Int
|
|
mentor - Boolean
|
|
mentorCapacity - Int
|
|
name - String
|
|
newProfileImage - UploadAttributes
|
|
onboarded - Boolean
|
|
peopleNetwork - [String!]
|
|
phoneNumber - String
|
|
preferredLanguageCode - String
|
|
profileImageRemoteUrl - String
|
|
profileImageSettings - ImageSettingsAttributes
|
|
pronouns - String
|
|
rate30 - Int
|
|
rate60 - Int
|
|
role - String
|
|
shortTermGoals - String
|
|
skills - String
|
|
slug - String
|
|
softSkills - String
|
|
subdisciplineIds - [ID!]
|
|
tagIds - [ID!]
|
|
timezone - String
|
|
twitterLink - String
|
|
vimeoLink - String
|
|
website - String
|
|
welcomeMessage - String
|
|
youtubeLink - String
|
Example
{
"activated": false,
"allowGroupSessions": true,
"approvedMentor": false,
"availabilityCalendarId": "4",
"behanceLink": "abc123",
"bookingLink": "xyz789",
"calendarId": "4",
"calendarProvider": "xyz789",
"calendarUrl": "abc123",
"cancellationPolicy": "abc123",
"cohortId": "4",
"company": "xyz789",
"contactEmail": "xyz789",
"countryCode": "xyz789",
"dateOfBirth": ISO8601Date,
"description": "abc123",
"disciplineId": "4",
"disciplineIds": [4],
"dribbbleLink": "xyz789",
"email": "xyz789",
"experience": 987,
"extensionNumber": "xyz789",
"externalId": "4",
"facebookLink": "xyz789",
"featuredMentor": false,
"hardSkills": "abc123",
"instagramLink": "abc123",
"languageCodes": ["xyz789"],
"linkedinLink": "abc123",
"location": "xyz789",
"longTermGoals": "abc123",
"market": "xyz789",
"menteeCapacity": 987,
"mentor": true,
"mentorCapacity": 987,
"name": "xyz789",
"newProfileImage": UploadAttributes,
"onboarded": true,
"peopleNetwork": ["abc123"],
"phoneNumber": "abc123",
"preferredLanguageCode": "abc123",
"profileImageRemoteUrl": "xyz789",
"profileImageSettings": ImageSettingsAttributes,
"pronouns": "abc123",
"rate30": 987,
"rate60": 123,
"role": "abc123",
"shortTermGoals": "abc123",
"skills": "xyz789",
"slug": "abc123",
"softSkills": "abc123",
"subdisciplineIds": [4],
"tagIds": ["4"],
"timezone": "xyz789",
"twitterLink": "abc123",
"vimeoLink": "xyz789",
"website": "xyz789",
"welcomeMessage": "abc123",
"youtubeLink": "xyz789"
}
UserConnections
Fields
| Field Name | Description |
|---|---|
facebook - ConnectionInfo!
|
|
google - ConnectionInfo!
|
|
linkedin - ConnectionInfo!
|
|
microsoft - ConnectionInfo!
|
|
zoom - ConnectionInfo!
|
Example
{
"facebook": ConnectionInfo,
"google": ConnectionInfo,
"linkedin": ConnectionInfo,
"microsoft": ConnectionInfo,
"zoom": ConnectionInfo
}
UserFile
Example
{
"displayHeight": 123,
"displayWidth": 123,
"fileUrl": "xyz789",
"height": 123,
"id": "4",
"imageUrl": "abc123",
"key": "xyz789",
"mimeType": "xyz789",
"position": 123,
"type": "xyz789",
"width": 123
}
UserGoal
Description
User goal
Fields
| Field Name | Description |
|---|---|
achievementReflection - String
|
|
completedAt - ISO8601DateTime
|
|
createdAt - ISO8601DateTime!
|
|
deletedAt - ISO8601DateTime
|
|
goalText - String!
|
|
id - ID!
|
|
isActive - Boolean!
|
|
isCompleted - Boolean!
|
|
isDeleted - Boolean!
|
|
progressNotes - [GoalProgressNote!]!
|
|
updatedAt - ISO8601DateTime!
|
|
user - User!
|
|
userId - ID!
|
Example
{
"achievementReflection": "abc123",
"completedAt": ISO8601DateTime,
"createdAt": ISO8601DateTime,
"deletedAt": ISO8601DateTime,
"goalText": "abc123",
"id": "4",
"isActive": true,
"isCompleted": false,
"isDeleted": false,
"progressNotes": [GoalProgressNote],
"updatedAt": ISO8601DateTime,
"user": User,
"userId": 4
}
UserGoalsAnalysis
Description
Analysis of user short-term and long-term goals
Fields
| Field Name | Description |
|---|---|
longTerm - GoalAnalysis!
|
Analysis of long-term goals |
metadata - AnalysisMetadata!
|
Metadata about the analysis including prompt used and input data |
shortTerm - GoalAnalysis!
|
Analysis of short-term goals |
Example
{
"longTerm": GoalAnalysis,
"metadata": AnalysisMetadata,
"shortTerm": GoalAnalysis
}
UserTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"mentee"
ValidateCalendarUrlPayload
Description
Autogenerated return type of ValidateCalendarUrl
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
isValid - Boolean!
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["abc123"],
"isValid": false,
"viewer": CurrentUser
}
ValidateResetPasswordTokenPayload
Description
Autogenerated return type of ValidateResetPasswordToken
Fields
| Field Name | Description |
|---|---|
errorDetails - JSON
|
|
errors - [String!]!
|
|
isValid - String!
|
|
viewer - CurrentUser
|
Example
{
"errorDetails": {},
"errors": ["xyz789"],
"isValid": "abc123",
"viewer": CurrentUser
}