--- title: "Ask a Question" method: POST path: "/api/v1/answers" tags: ["Answers"] --- # Ask a Question `POST /api/v1/answers` Ask Guru a question, and receive an AI-generated answer with up to three source records. ## Request body - AnswerQuerySpec - `question` string - `groups` string[] - `collectionIds` string[] - `sourceIds` string[] - `agentId` string ## Response `200` successful operation - Answer - `answer` string - `answerId` string - `sources` Document[] - union - CardDocument — The Card is the basic unit of knowledge in Guru - `id` string — ID of the Card - `lastModified` string, date-time — Date the Card was last modified - `version` integer — Current version of the Card. As the card gets updated and revised, the version number will increase. - `inaccessibleToAsker` boolean - `inaccessible` boolean - `latestVersion` integer - `deleted` boolean - `dateCreated` string, date-time — Date the Card was created - `url` string - `title` string - `documentType` 'GURU', required - `content` string, required — The Card's HTML or Markdown content - `owner` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - … - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `verificationType` 'ABSOLUTE' | 'RELATIVE' — Whether the card's verification date is ABSOLUTE or RELATIVE - `slug` string — The slug is the URL address to the card - `favoritedDate` string, date-time — Date when this card has been favorited by the current user - `favorited` boolean — Whether this card has been favorited by the current user - `publicLinkAllowed` boolean - `archived` boolean — Indicates if the Card has been archived - `cardType` 'CARD' | 'QUESTION' — The type of the Card. CARD for content cards, QUESTION for Questions. - `nextVerificationDate` string, date-time — Next date that this Card needs verification dependent on verification interval - `originalOwner` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - … - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `lastViewed` string, date-time — Last time the card was viewed - `collaborators` CardCollaborator[] — Users/Groups that this card is explicitly shared to. Collaborators of a card are the only ones who have access if the Card's shareStatus is PRIVATE. - union - UserCollaborator - … - UserGroupCollaborator - … - `attachments` CardAttachment[] — Attachments to the card - `id` string — The ID of the CardAttachment - `size` integer — The attached file's size in bytes - `extension` string — The attached file's extension - `mimetype` string - `link` string — Link to where the uploaded file is hosted in Guru's servers - `thumbnailLink` string — Link to where the thumbnail for the uploaded file is hosted in Guru's servers - `previewable` boolean - `filename` string — The file name and extension - `verificationReasons` string[] - `verificationInitiator` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - … - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `commentCount` integer — Number of comments on the card - `cardInfo` CardInfo - `analytics` object - `membersWithCardView` integer - `membersWithoutCardView` integer - `boards` Board[] - `boardGroupId` string — The ID of the Board Group that this Board belongs to - `removed` boolean — Boolean flag if this Board has been removed - `id` string — The ID of the directory - `lastModified` string, date-time — The date that the directory was last modified - `groupsSharedWith` string[] — Returns the groups that a directory is shared with - `slug` string — The slug is the URL address to the directory - `numberOfFacts` integer — The number of cards in the directory - `favoritedDate` string, date-time — When this directory has been favorited by the current user - `favorited` boolean — Whether this board has been favorited by the current user - `collection` CollectionModel - … - `lastModifiedBy` User - … - `description` string — An optional short description of the directory - `title` string — The title of the directory - `syncInfo` CardSyncInfo - `externalUrl` string - `lastSyncDate` string, date-time - `lastUpdateDate` string, date-time - `contentSyncType` 'ZENDESK' | 'ZENDESK_IMPORT' | 'CONFLUENCE' | 'MANUAL' | 'GOOGLE_DRIVE' | 'ZENEFITS' | 'BOX' | 'KUSTOMER' | 'DROPBOX' | 'SALESFORCE' | 'GURU' - `suppressVerification` boolean — Flag for enabling card verification on save - `verificationInitiationDate` string, date-time — Date corresponding to the action that unverified the card - `cardTemplateId` string — ID of the template from which this card was created if applicable - `folderCount` integer — The number of folders this card is in - `answerId` string - `commentsEnabled` boolean — A flag to indicate if comments are allowed on this Card - `pendingAutoArchive` boolean — A flag to indicate if this unverified card is currently in an auto archive queue - `settingsUpdate` boolean — A flag to indicate if the changes are only updating the settings of the card - `collection` CollectionModel - `name` string — Collection Name - `readOnly` boolean - `id` string — ID of the collection - `color` string — A hex value for the color of the Collection - `emoji` string - `slug` string — The slug is the URL to get to this Collection - `collectionStats` CollectionStats - `stats` object — Returns an object that includes the Collection Trust Score, and Card Count of the Collection. - `lastSyncedDate` string, date-time — The date that the Collection was last synced from the source - `topLevelSyncLocation` string — The URL where the content of the Collection is being synced from - `publicCards` integer - `madeByGuru` boolean - `homeBoardSlug` string - `syncType` 'ZENDESK' | 'ZENDESK_IMPORT' | 'CONFLUENCE' | 'MANUAL' | 'GOOGLE_DRIVE' | 'ZENEFITS' | 'BOX' | 'KUSTOMER' | 'DROPBOX' | 'SALESFORCE' | 'GURU' — If this Collection has been synced, this will return the type. Types include: Zendesk, Confluence, Google Drive, and Manual. - `deleted` boolean — Flag for whether this Collection has been deleted - `team` Team - `name` string — Team Name - `id` string — ID of the fact - `profilePicUrl` string - `companyName` string — Team Company Name - `currentUserIsMember` boolean - `domain` string — Domain - `edition` TeamEdition - … - `billableUsers` integer - `totalUsers` integer - `teamDomains` TeamDomain[] - … - `slackCommandState` string - `slackCommandInstalled` boolean - `sfdcIntegrationState` string - `sfdcIntegrationInstalled` boolean - `clearProfilePic` boolean - `defaultGroup` UserGroup - … - `defaultUserType` 'FREE_CORE' | 'CORE' - `trialExpirationDate` string, date-time - `zendeskAssistState` string - `zendeskAssistInstalled` boolean - `zendeskKnowledgeState` string - `zendeskKnowledgeInstalled` boolean - `fileSharingDisabled` boolean - `collectionCreated` boolean - `teamCreationToken` string - `cardsCreated` integer - `topLevelOrganizationId` string - `numberOfCollections` integer - `numberOfOrgSharedCollections` integer - `allMembersGroupId` string - `deleted` boolean — Indicates if the fact has been deleted - `dateCreated` string, date-time — Date the team was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `userRole` string - `useCase` string - `description` string - `status` 'ACTIVE' | 'DORMANT' | 'LOCKED' | 'EXPIRED' | 'LOCKED_PAY' - `organization` Organization - … - `defaultVerifier` string - `boards` integer — Number of boards in this Collection - `dateCreated` string, date-time — Date the collection was created - `collectionType` 'INTERNAL' | 'EXTERNAL' — The type can be either INTERNAL or EXTERNAL. EXTERNAL indicates that the card is from a synced Collection. - `publicCardsEnabled` boolean - `syncVerificationEnabled` boolean - `collectionTypeDetail` 'ONBOARDING' | 'FRAMEWORK' | 'USER' | 'EXTERNAL' | 'SOURCE' | 'WELCOME' | 'ONBOARDING_UNEDITED' — The type can be FRAMEWORK, ONBOARDING, USER or EXTERNAL. - `verificationInterval` integer - `cards` integer — Number of cards in this Collection - `administrator` boolean - `description` string — Collection Description - `tags` integer — Returns all Tag objects associated with this collection - `token` string - `lastVerified` string, date-time — Date the Card was last verified - `lastVerifiedBy` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - … - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `lastModifiedBy` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - … - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `boards` Board[] — Returns Board objects that this card appears on - `boardGroupId` string — The ID of the Board Group that this Board belongs to - `removed` boolean — Boolean flag if this Board has been removed - `id` string — The ID of the directory - `lastModified` string, date-time — The date that the directory was last modified - `groupsSharedWith` string[] — Returns the groups that a directory is shared with - `slug` string — The slug is the URL address to the directory - `numberOfFacts` integer — The number of cards in the directory - `favoritedDate` string, date-time — When this directory has been favorited by the current user - `favorited` boolean — Whether this board has been favorited by the current user - `collection` CollectionModel - `name` string — Collection Name - `readOnly` boolean - `id` string — ID of the collection - `color` string — A hex value for the color of the Collection - `emoji` string - `slug` string — The slug is the URL to get to this Collection - `collectionStats` CollectionStats - … - `lastSyncedDate` string, date-time — The date that the Collection was last synced from the source - `topLevelSyncLocation` string — The URL where the content of the Collection is being synced from - `publicCards` integer - `madeByGuru` boolean - `homeBoardSlug` string - `syncType` 'ZENDESK' | 'ZENDESK_IMPORT' | 'CONFLUENCE' | 'MANUAL' | 'GOOGLE_DRIVE' | 'ZENEFITS' | 'BOX' | 'KUSTOMER' | 'DROPBOX' | 'SALESFORCE' | 'GURU' — If this Collection has been synced, this will return the type. Types include: Zendesk, Confluence, Google Drive, and Manual. - `deleted` boolean — Flag for whether this Collection has been deleted - `team` Team - … - `defaultVerifier` string - `boards` integer — Number of boards in this Collection - `dateCreated` string, date-time — Date the collection was created - `collectionType` 'INTERNAL' | 'EXTERNAL' — The type can be either INTERNAL or EXTERNAL. EXTERNAL indicates that the card is from a synced Collection. - `publicCardsEnabled` boolean - `syncVerificationEnabled` boolean - `collectionTypeDetail` 'ONBOARDING' | 'FRAMEWORK' | 'USER' | 'EXTERNAL' | 'SOURCE' | 'WELCOME' | 'ONBOARDING_UNEDITED' — The type can be FRAMEWORK, ONBOARDING, USER or EXTERNAL. - `verificationInterval` integer - `cards` integer — Number of cards in this Collection - `administrator` boolean - `description` string — Collection Description - `tags` integer — Returns all Tag objects associated with this collection - `token` string - `lastModifiedBy` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - … - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `description` string — An optional short description of the directory - `title` string — The title of the directory - `shareStatus` 'PRIVATE' | 'TEAM' | 'PUBLIC' — The share status of the Card. TEAM for team shared cards and PRIVATE for privately shared cards - `verificationInterval` integer — Time interval (in days), indicating the frequency that this card needs re-verification. Passing in null will default to 30 days. - `verifiers` CardVerifier[] — Users/Groups that are responsible for verifying this card - union - UserGroupVerifier - … - UserVerifier - … - `verificationState` 'TRUSTED' | 'STALE' | 'NEEDS_VERIFICATION' | 'SYNCED_NO_VERIFICATION' — Whether the card is TRUSTED, STALE, or NEEDS_VERIFICATION - `verificationReason` 'UPDATE' | 'NEW_VERIFIER' | 'QUESTION' | 'REQUESTED' | 'EXPIRED' — Reason this card needs verification. UPDATE if this card was updated by a user that is not the verifier. NEW_VERIFIER if this card was assigned to a new verifier but has not yet been verified. This value will only be present if the verification state is NEEDS_VERIFICATION - `tags` Tag[] — Returns Tag objects associated with this card - `value` string — The name of the Tag - `id` string — The ID of the Tag - `numberOfCards` integer — The number of cards associated with this Tag - `categoryId` string — If the tag belongs to a category, this is the ID for the category - `categoryName` string — If the tag belongs to a category, this is the name for the category - SourceDocument - `id` string - `lastModified` string, date-time - `version` integer - `inaccessibleToAsker` boolean - `inaccessible` boolean - `latestVersion` integer - `deleted` boolean - `dateCreated` string, date-time - `url` string - `title` string - `documentType` 'SOURCE', required - `content` string - `source` Source - `name` string - `id` string - `definition` SourceDefinition - `name` string - `id` string - `type` string - `manualSyncAllowed` boolean - `configType` 'GOOGLE_DRIVE' | 'GOOGLE_DRIVE_V2' | 'SLACK' | 'CUSTOM' | 'GURU_IPAAS' | 'GSHEET' | 'MERGE_FILE' | 'MERGE_TICKET' | 'MERGE_CRM' | 'FILE_UPLOAD' - `requestAccess` boolean - `config` SourceDefinitionConfig - … - `availability` 'NONE' | 'GENERAL' | 'TEAM' - `category` string - `iconUrl` string - `config` union - CustomSourceConfig - … - FileUploadSourceConfig - … - GSheetSourceConfig - … - GoogleDriveSourceConfig - … - GoogleDriveV2SourceConfig - … - GuruIPaasSourceConfig - … - MergeCRMSourceConfig - … - MergeFileStorageSourceConfig - … - MergeTicketingSourceConfig - … - SlackSourceConfig - … - `lastSyncedDate` string, date-time - `statusReason` 'INVALID_AUTHENTICATION' | 'UNAUTHORIZED' | 'NO_API_ACCESS' | 'TARGET_INACCESSIBLE' | 'TOO_LARGE' | 'TARGET_INSECURE' | 'AUTH_EXPIRED' | 'MISSING_FEATURE' | 'API_ERROR' | 'NO_ADMIN' | 'API_TIMEOUT' | 'API_INTERRUPTED' | 'PARSING_ERROR' | 'EXTRACTION_ERROR' | 'HOMEBOARD_IMPORT_FAILED' | 'JOB_TIMEOUT' | 'UNKNOWN_ERROR' - `iconUrl` string - `lastSyncAttempt` string, date-time - `syncStatus` 'SYNCING' | 'SYNCED' | 'FAILED' | 'INVALID' - `connectionId` string - `authorizedBy` string - `sourceObjectTypes` ObjectType[] - `name` string - `fields` ObjectField[] - … - `id` string - `externalId` string - `analyticsEnabled` boolean - `application` Application - … - `dataType` 'JSON' | 'TEXT' | 'HTML' | 'MARKDOWN' | 'MIXED_HTML_MARKDOWN' - `sourceDataType` 'RECORD' | 'STRUCTURED' - `currentSyncNumber` integer - `templates` ObjectTypeTemplates - … - `connectionName` string - `objectSyncs` SourceObjectSync[] - `objectType` ObjectType - … - `lastSyncedDate` string, date-time - `statusReason` 'INVALID_AUTHENTICATION' | 'UNAUTHORIZED' | 'NO_API_ACCESS' | 'TARGET_INACCESSIBLE' | 'TOO_LARGE' | 'TARGET_INSECURE' | 'AUTH_EXPIRED' | 'MISSING_FEATURE' | 'API_ERROR' | 'NO_ADMIN' | 'API_TIMEOUT' | 'API_INTERRUPTED' | 'PARSING_ERROR' | 'EXTRACTION_ERROR' | 'HOMEBOARD_IMPORT_FAILED' | 'JOB_TIMEOUT' | 'UNKNOWN_ERROR' - `lastSyncAttempt` string, date-time - `syncStatus` 'SYNCING' | 'SYNCED' | 'FAILED' | 'INVALID' - `lastSyncCompleted` string, date-time - `objectCount` integer - `useSourceNativePermissions` boolean - `mergeIssues` LinkedAccountIssue[] - `id` string - `status` string - `errorDescription` string - `errorDetails` string[] - `muted` boolean - `firstIncidentTime` string, date-time - `lastIncidentTime` string, date-time - `userEmail` string - `integration` string - `team` Team - `name` string — Team Name - `id` string — ID of the fact - `profilePicUrl` string - `companyName` string — Team Company Name - `currentUserIsMember` boolean - `domain` string — Domain - `edition` TeamEdition - … - `billableUsers` integer - `totalUsers` integer - `teamDomains` TeamDomain[] - … - `slackCommandState` string - `slackCommandInstalled` boolean - `sfdcIntegrationState` string - `sfdcIntegrationInstalled` boolean - `clearProfilePic` boolean - `defaultGroup` UserGroup - … - `defaultUserType` 'FREE_CORE' | 'CORE' - `trialExpirationDate` string, date-time - `zendeskAssistState` string - `zendeskAssistInstalled` boolean - `zendeskKnowledgeState` string - `zendeskKnowledgeInstalled` boolean - `fileSharingDisabled` boolean - `collectionCreated` boolean - `teamCreationToken` string - `cardsCreated` integer - `topLevelOrganizationId` string - `numberOfCollections` integer - `numberOfOrgSharedCollections` integer - `allMembersGroupId` string - `deleted` boolean — Indicates if the fact has been deleted - `dateCreated` string, date-time — Date the team was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `userRole` string - `useCase` string - `description` string - `status` 'ACTIVE' | 'DORMANT' | 'LOCKED' | 'EXPIRED' | 'LOCKED_PAY' - `organization` Organization - … - `createdBy` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - … - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `latestFeedback` 'THUMBS_UP' | 'THUMBS_DOWN' | 'THUMBS_UP_UNSELECTED' | 'THUMBS_DOWN_UNSELECTED' - `asker` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - `description` string — A description of this use case - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `answerDate` string, date-time - `status` 'ANSWERED' | 'NOT_ANSWERED' | 'ASSIGNED' | 'FLAGGED' | 'HELPFUL' | 'ALL' | 'MY_ASSIGNED' - `question` string - `linkedQuestion` Card — The Card is the basic unit of knowledge in Guru - `id` string — ID of the Card - `content` string, required — The Card's HTML or Markdown content - `owner` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - `description` string — A description of this use case - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `lastModified` string, date-time — Date the Card was last modified - `version` integer — Current version of the Card. As the card gets updated and revised, the version number will increase. - `verificationType` 'ABSOLUTE' | 'RELATIVE' — Whether the card's verification date is ABSOLUTE or RELATIVE - `slug` string — The slug is the URL address to the card - `favoritedDate` string, date-time — Date when this card has been favorited by the current user - `favorited` boolean — Whether this card has been favorited by the current user - `publicLinkAllowed` boolean - `archived` boolean — Indicates if the Card has been archived - `cardType` 'CARD' | 'QUESTION' — The type of the Card. CARD for content cards, QUESTION for Questions. - `nextVerificationDate` string, date-time — Next date that this Card needs verification dependent on verification interval - `originalOwner` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - `description` string — A description of this use case - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `lastViewed` string, date-time — Last time the card was viewed - `collaborators` CardCollaborator[] — Users/Groups that this card is explicitly shared to. Collaborators of a card are the only ones who have access if the Card's shareStatus is PRIVATE. - union - UserCollaborator - `id` string — The ID (email address or group ID) of the collaborator - `removed` boolean - `dateCreated` string, date-time — Date the collaborator was created - `type` 'user', required - `user` User, required - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - … - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - UserGroupCollaborator - `id` string — The ID (email address or group ID) of the collaborator - `removed` boolean - `dateCreated` string, date-time — Date the collaborator was created - `type` 'user-group', required - `userGroup` UserGroup - `name` string — Group Name - `id` string — ID of the group - `members` UserGroupMember[] - … - `expertIdRank` integer - `numberOfCardsAsVerifier` integer - `managedByScim` boolean - `groupIdentifier` string - `numberOfMembers` integer - `modifiable` boolean - `userModifiable` boolean - `singleUser` boolean - `team` Team - … - `dateCreated` string, date-time — Date the group was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `role` 'ADMIN' | 'AUTHOR' | 'MEMBER' | 'COLL_ADMIN' - `attachments` CardAttachment[] — Attachments to the card - `id` string — The ID of the CardAttachment - `size` integer — The attached file's size in bytes - `extension` string — The attached file's extension - `mimetype` string - `link` string — Link to where the uploaded file is hosted in Guru's servers - `thumbnailLink` string — Link to where the thumbnail for the uploaded file is hosted in Guru's servers - `previewable` boolean - `filename` string — The file name and extension - `verificationReasons` string[] - `verificationInitiator` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - `description` string — A description of this use case - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `commentCount` integer — Number of comments on the card - `cardInfo` CardInfo - `analytics` object - `membersWithCardView` integer - `membersWithoutCardView` integer - `boards` Board[] - `boardGroupId` string — The ID of the Board Group that this Board belongs to - `removed` boolean — Boolean flag if this Board has been removed - `id` string — The ID of the directory - `lastModified` string, date-time — The date that the directory was last modified - `groupsSharedWith` string[] — Returns the groups that a directory is shared with - `slug` string — The slug is the URL address to the directory - `numberOfFacts` integer — The number of cards in the directory - `favoritedDate` string, date-time — When this directory has been favorited by the current user - `favorited` boolean — Whether this board has been favorited by the current user - `collection` CollectionModel - `name` string — Collection Name - `readOnly` boolean - `id` string — ID of the collection - `color` string — A hex value for the color of the Collection - `emoji` string - `slug` string — The slug is the URL to get to this Collection - `collectionStats` CollectionStats - `stats` object — Returns an object that includes the Collection Trust Score, and Card Count of the Collection. - `lastSyncedDate` string, date-time — The date that the Collection was last synced from the source - `topLevelSyncLocation` string — The URL where the content of the Collection is being synced from - `publicCards` integer - `madeByGuru` boolean - `homeBoardSlug` string - `syncType` 'ZENDESK' | 'ZENDESK_IMPORT' | 'CONFLUENCE' | 'MANUAL' | 'GOOGLE_DRIVE' | 'ZENEFITS' | 'BOX' | 'KUSTOMER' | 'DROPBOX' | 'SALESFORCE' | 'GURU' — If this Collection has been synced, this will return the type. Types include: Zendesk, Confluence, Google Drive, and Manual. - `deleted` boolean — Flag for whether this Collection has been deleted - `team` Team - `name` string — Team Name - `id` string — ID of the fact - `profilePicUrl` string - `companyName` string — Team Company Name - `currentUserIsMember` boolean - `domain` string — Domain - `edition` TeamEdition - … - `billableUsers` integer - `totalUsers` integer - `teamDomains` TeamDomain[] - … - `slackCommandState` string - `slackCommandInstalled` boolean - `sfdcIntegrationState` string - `sfdcIntegrationInstalled` boolean - `clearProfilePic` boolean - `defaultGroup` UserGroup - … - `defaultUserType` 'FREE_CORE' | 'CORE' - `trialExpirationDate` string, date-time - `zendeskAssistState` string - `zendeskAssistInstalled` boolean - `zendeskKnowledgeState` string - `zendeskKnowledgeInstalled` boolean - `fileSharingDisabled` boolean - `collectionCreated` boolean - `teamCreationToken` string - `cardsCreated` integer - `topLevelOrganizationId` string - `numberOfCollections` integer - `numberOfOrgSharedCollections` integer - `allMembersGroupId` string - `deleted` boolean — Indicates if the fact has been deleted - `dateCreated` string, date-time — Date the team was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `userRole` string - `useCase` string - `description` string - `status` 'ACTIVE' | 'DORMANT' | 'LOCKED' | 'EXPIRED' | 'LOCKED_PAY' - `organization` Organization - … - `defaultVerifier` string - `boards` integer — Number of boards in this Collection - `dateCreated` string, date-time — Date the collection was created - `collectionType` 'INTERNAL' | 'EXTERNAL' — The type can be either INTERNAL or EXTERNAL. EXTERNAL indicates that the card is from a synced Collection. - `publicCardsEnabled` boolean - `syncVerificationEnabled` boolean - `collectionTypeDetail` 'ONBOARDING' | 'FRAMEWORK' | 'USER' | 'EXTERNAL' | 'SOURCE' | 'WELCOME' | 'ONBOARDING_UNEDITED' — The type can be FRAMEWORK, ONBOARDING, USER or EXTERNAL. - `verificationInterval` integer - `cards` integer — Number of cards in this Collection - `administrator` boolean - `description` string — Collection Description - `tags` integer — Returns all Tag objects associated with this collection - `token` string - `lastModifiedBy` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - … - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `description` string — An optional short description of the directory - `title` string — The title of the directory - `syncInfo` CardSyncInfo - `externalUrl` string - `lastSyncDate` string, date-time - `lastUpdateDate` string, date-time - `contentSyncType` 'ZENDESK' | 'ZENDESK_IMPORT' | 'CONFLUENCE' | 'MANUAL' | 'GOOGLE_DRIVE' | 'ZENEFITS' | 'BOX' | 'KUSTOMER' | 'DROPBOX' | 'SALESFORCE' | 'GURU' - `suppressVerification` boolean — Flag for enabling card verification on save - `verificationInitiationDate` string, date-time — Date corresponding to the action that unverified the card - `cardTemplateId` string — ID of the template from which this card was created if applicable - `folderCount` integer — The number of folders this card is in - `answerId` string - `commentsEnabled` boolean — A flag to indicate if comments are allowed on this Card - `pendingAutoArchive` boolean — A flag to indicate if this unverified card is currently in an auto archive queue - `settingsUpdate` boolean — A flag to indicate if the changes are only updating the settings of the card - `collection` CollectionModel - `name` string — Collection Name - `readOnly` boolean - `id` string — ID of the collection - `color` string — A hex value for the color of the Collection - `emoji` string - `slug` string — The slug is the URL to get to this Collection - `collectionStats` CollectionStats - `stats` object — Returns an object that includes the Collection Trust Score, and Card Count of the Collection. - `lastSyncedDate` string, date-time — The date that the Collection was last synced from the source - `topLevelSyncLocation` string — The URL where the content of the Collection is being synced from - `publicCards` integer - `madeByGuru` boolean - `homeBoardSlug` string - `syncType` 'ZENDESK' | 'ZENDESK_IMPORT' | 'CONFLUENCE' | 'MANUAL' | 'GOOGLE_DRIVE' | 'ZENEFITS' | 'BOX' | 'KUSTOMER' | 'DROPBOX' | 'SALESFORCE' | 'GURU' — If this Collection has been synced, this will return the type. Types include: Zendesk, Confluence, Google Drive, and Manual. - `deleted` boolean — Flag for whether this Collection has been deleted - `team` Team - `name` string — Team Name - `id` string — ID of the fact - `profilePicUrl` string - `companyName` string — Team Company Name - `currentUserIsMember` boolean - `domain` string — Domain - `edition` TeamEdition - `adminOverrides` object - `name` string - `key` string - `id` string - `usage` object - `code` string - `features` object - `billableUsers` integer - `totalUsers` integer - `teamDomains` TeamDomain[] - `verificationCode` string - `verified` boolean - `capture` boolean - `domain` string - `slackCommandState` string - `slackCommandInstalled` boolean - `sfdcIntegrationState` string - `sfdcIntegrationInstalled` boolean - `clearProfilePic` boolean - `defaultGroup` UserGroup - `name` string — Group Name - `id` string — ID of the group - `members` UserGroupMember[] - `id` string — ID of the group member - `managedByScim` boolean - `dateCreated` string, date-time — Date the group member was added to the group. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `user` User, required - … - `expertIdRank` integer - `numberOfCardsAsVerifier` integer - `managedByScim` boolean - `groupIdentifier` string - `numberOfMembers` integer - `modifiable` boolean - `userModifiable` boolean - `singleUser` boolean - `team` Team — recursive - `dateCreated` string, date-time — Date the group was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `role` 'ADMIN' | 'AUTHOR' | 'MEMBER' | 'COLL_ADMIN' - `defaultUserType` 'FREE_CORE' | 'CORE' - `trialExpirationDate` string, date-time - `zendeskAssistState` string - `zendeskAssistInstalled` boolean - `zendeskKnowledgeState` string - `zendeskKnowledgeInstalled` boolean - `fileSharingDisabled` boolean - `collectionCreated` boolean - `teamCreationToken` string - `cardsCreated` integer - `topLevelOrganizationId` string - `numberOfCollections` integer - `numberOfOrgSharedCollections` integer - `allMembersGroupId` string - `deleted` boolean — Indicates if the fact has been deleted - `dateCreated` string, date-time — Date the team was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `userRole` string - `useCase` string - `description` string - `status` 'ACTIVE' | 'DORMANT' | 'LOCKED' | 'EXPIRED' | 'LOCKED_PAY' - `organization` Organization - `name` string - `id` string - `workspaces` Team[] - `defaultVerifier` string - `boards` integer — Number of boards in this Collection - `dateCreated` string, date-time — Date the collection was created - `collectionType` 'INTERNAL' | 'EXTERNAL' — The type can be either INTERNAL or EXTERNAL. EXTERNAL indicates that the card is from a synced Collection. - `publicCardsEnabled` boolean - `syncVerificationEnabled` boolean - `collectionTypeDetail` 'ONBOARDING' | 'FRAMEWORK' | 'USER' | 'EXTERNAL' | 'SOURCE' | 'WELCOME' | 'ONBOARDING_UNEDITED' — The type can be FRAMEWORK, ONBOARDING, USER or EXTERNAL. - `verificationInterval` integer - `cards` integer — Number of cards in this Collection - `administrator` boolean - `description` string — Collection Description - `tags` integer — Returns all Tag objects associated with this collection - `token` string - `lastVerified` string, date-time — Date the Card was last verified - `lastVerifiedBy` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - `description` string — A description of this use case - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `lastModifiedBy` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - `description` string — A description of this use case - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `preferredPhrase` string, required — The title of the Card - `boards` Board[] — Returns Board objects that this card appears on - `boardGroupId` string — The ID of the Board Group that this Board belongs to - `removed` boolean — Boolean flag if this Board has been removed - `id` string — The ID of the directory - `lastModified` string, date-time — The date that the directory was last modified - `groupsSharedWith` string[] — Returns the groups that a directory is shared with - `slug` string — The slug is the URL address to the directory - `numberOfFacts` integer — The number of cards in the directory - `favoritedDate` string, date-time — When this directory has been favorited by the current user - `favorited` boolean — Whether this board has been favorited by the current user - `collection` CollectionModel - `name` string — Collection Name - `readOnly` boolean - `id` string — ID of the collection - `color` string — A hex value for the color of the Collection - `emoji` string - `slug` string — The slug is the URL to get to this Collection - `collectionStats` CollectionStats - `stats` object — Returns an object that includes the Collection Trust Score, and Card Count of the Collection. - `lastSyncedDate` string, date-time — The date that the Collection was last synced from the source - `topLevelSyncLocation` string — The URL where the content of the Collection is being synced from - `publicCards` integer - `madeByGuru` boolean - `homeBoardSlug` string - `syncType` 'ZENDESK' | 'ZENDESK_IMPORT' | 'CONFLUENCE' | 'MANUAL' | 'GOOGLE_DRIVE' | 'ZENEFITS' | 'BOX' | 'KUSTOMER' | 'DROPBOX' | 'SALESFORCE' | 'GURU' — If this Collection has been synced, this will return the type. Types include: Zendesk, Confluence, Google Drive, and Manual. - `deleted` boolean — Flag for whether this Collection has been deleted - `team` Team - `name` string — Team Name - `id` string — ID of the fact - `profilePicUrl` string - `companyName` string — Team Company Name - `currentUserIsMember` boolean - `domain` string — Domain - `edition` TeamEdition - `adminOverrides` object - `name` string - `key` string - `id` string - `usage` object - `code` string - `features` object - `billableUsers` integer - `totalUsers` integer - `teamDomains` TeamDomain[] - `verificationCode` string - `verified` boolean - `capture` boolean - `domain` string - `slackCommandState` string - `slackCommandInstalled` boolean - `sfdcIntegrationState` string - `sfdcIntegrationInstalled` boolean - `clearProfilePic` boolean - `defaultGroup` UserGroup - `name` string — Group Name - `id` string — ID of the group - `members` UserGroupMember[] - … - `expertIdRank` integer - `numberOfCardsAsVerifier` integer - `managedByScim` boolean - `groupIdentifier` string - `numberOfMembers` integer - `modifiable` boolean - `userModifiable` boolean - `singleUser` boolean - `team` Team — recursive - `dateCreated` string, date-time — Date the group was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `role` 'ADMIN' | 'AUTHOR' | 'MEMBER' | 'COLL_ADMIN' - `defaultUserType` 'FREE_CORE' | 'CORE' - `trialExpirationDate` string, date-time - `zendeskAssistState` string - `zendeskAssistInstalled` boolean - `zendeskKnowledgeState` string - `zendeskKnowledgeInstalled` boolean - `fileSharingDisabled` boolean - `collectionCreated` boolean - `teamCreationToken` string - `cardsCreated` integer - `topLevelOrganizationId` string - `numberOfCollections` integer - `numberOfOrgSharedCollections` integer - `allMembersGroupId` string - `deleted` boolean — Indicates if the fact has been deleted - `dateCreated` string, date-time — Date the team was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `userRole` string - `useCase` string - `description` string - `status` 'ACTIVE' | 'DORMANT' | 'LOCKED' | 'EXPIRED' | 'LOCKED_PAY' - `organization` Organization - `name` string - `id` string - `workspaces` Team[] - `defaultVerifier` string - `boards` integer — Number of boards in this Collection - `dateCreated` string, date-time — Date the collection was created - `collectionType` 'INTERNAL' | 'EXTERNAL' — The type can be either INTERNAL or EXTERNAL. EXTERNAL indicates that the card is from a synced Collection. - `publicCardsEnabled` boolean - `syncVerificationEnabled` boolean - `collectionTypeDetail` 'ONBOARDING' | 'FRAMEWORK' | 'USER' | 'EXTERNAL' | 'SOURCE' | 'WELCOME' | 'ONBOARDING_UNEDITED' — The type can be FRAMEWORK, ONBOARDING, USER or EXTERNAL. - `verificationInterval` integer - `cards` integer — Number of cards in this Collection - `administrator` boolean - `description` string — Collection Description - `tags` integer — Returns all Tag objects associated with this collection - `token` string - `lastModifiedBy` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - `description` string — A description of this use case - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `description` string — An optional short description of the directory - `title` string — The title of the directory - `shareStatus` 'PRIVATE' | 'TEAM' | 'PUBLIC' — The share status of the Card. TEAM for team shared cards and PRIVATE for privately shared cards - `dateCreated` string, date-time — Date the Card was created - `verificationInterval` integer — Time interval (in days), indicating the frequency that this card needs re-verification. Passing in null will default to 30 days. - `verifiers` CardVerifier[] — Users/Groups that are responsible for verifying this card - union - UserGroupVerifier - `id` string — ID of the verifier - `dateCreated` string, date-time — Date the verifier was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `type` 'user-group', required - `userGroup` UserGroup - `name` string — Group Name - `id` string — ID of the group - `members` UserGroupMember[] - … - `expertIdRank` integer - `numberOfCardsAsVerifier` integer - `managedByScim` boolean - `groupIdentifier` string - `numberOfMembers` integer - `modifiable` boolean - `userModifiable` boolean - `singleUser` boolean - `team` Team - … - `dateCreated` string, date-time — Date the group was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `role` 'ADMIN' | 'AUTHOR' | 'MEMBER' | 'COLL_ADMIN' - UserVerifier - `id` string — ID of the verifier - `dateCreated` string, date-time — Date the verifier was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `type` 'user', required - `user` User, required - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - … - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `verificationState` 'TRUSTED' | 'STALE' | 'NEEDS_VERIFICATION' | 'SYNCED_NO_VERIFICATION' — Whether the card is TRUSTED, STALE, or NEEDS_VERIFICATION - `verificationReason` 'UPDATE' | 'NEW_VERIFIER' | 'QUESTION' | 'REQUESTED' | 'EXPIRED' — Reason this card needs verification. UPDATE if this card was updated by a user that is not the verifier. NEW_VERIFIER if this card was assigned to a new verifier but has not yet been verified. This value will only be present if the verification state is NEEDS_VERIFICATION - `tags` Tag[] — Returns Tag objects associated with this card - `value` string — The name of the Tag - `id` string — The ID of the Tag - `numberOfCards` integer — The number of cards associated with this Tag - `categoryId` string — If the tag belongs to a category, this is the ID for the category - `categoryName` string — If the tag belongs to a category, this is the name for the category - `linkedQuestionAssignee` union - UserGroupVerifier - `id` string — ID of the verifier - `dateCreated` string, date-time — Date the verifier was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `type` 'user-group', required - `userGroup` UserGroup - `name` string — Group Name - `id` string — ID of the group - `members` UserGroupMember[] - `id` string — ID of the group member - `managedByScim` boolean - `dateCreated` string, date-time — Date the group member was added to the group. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `user` User, required - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - … - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `expertIdRank` integer - `numberOfCardsAsVerifier` integer - `managedByScim` boolean - `groupIdentifier` string - `numberOfMembers` integer - `modifiable` boolean - `userModifiable` boolean - `singleUser` boolean - `team` Team - `name` string — Team Name - `id` string — ID of the fact - `profilePicUrl` string - `companyName` string — Team Company Name - `currentUserIsMember` boolean - `domain` string — Domain - `edition` TeamEdition - `adminOverrides` object - `name` string - `key` string - `id` string - `usage` object - `code` string - `features` object - `billableUsers` integer - `totalUsers` integer - `teamDomains` TeamDomain[] - `verificationCode` string - `verified` boolean - `capture` boolean - `domain` string - `slackCommandState` string - `slackCommandInstalled` boolean - `sfdcIntegrationState` string - `sfdcIntegrationInstalled` boolean - `clearProfilePic` boolean - `defaultGroup` UserGroup — recursive - `defaultUserType` 'FREE_CORE' | 'CORE' - `trialExpirationDate` string, date-time - `zendeskAssistState` string - `zendeskAssistInstalled` boolean - `zendeskKnowledgeState` string - `zendeskKnowledgeInstalled` boolean - `fileSharingDisabled` boolean - `collectionCreated` boolean - `teamCreationToken` string - `cardsCreated` integer - `topLevelOrganizationId` string - `numberOfCollections` integer - `numberOfOrgSharedCollections` integer - `allMembersGroupId` string - `deleted` boolean — Indicates if the fact has been deleted - `dateCreated` string, date-time — Date the team was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `userRole` string - `useCase` string - `description` string - `status` 'ACTIVE' | 'DORMANT' | 'LOCKED' | 'EXPIRED' | 'LOCKED_PAY' - `organization` Organization - `name` string - `id` string - `workspaces` Team[] - `dateCreated` string, date-time — Date the group was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `role` 'ADMIN' | 'AUTHOR' | 'MEMBER' | 'COLL_ADMIN' - UserVerifier - `id` string — ID of the verifier - `dateCreated` string, date-time — Date the verifier was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `type` 'user', required - `user` User, required - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - `description` string — A description of this use case - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `answered` boolean - `previewAnswerId` string - `answerer` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - `description` string — A description of this use case - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `searchAssistant` SearchAssistant - `id` string, uuid - `name` string - `generativeConfig` GenerativeConfig - `id` string - `provider` 'OPENAI' - `promptContent` string - `createdBy` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - `description` string — A description of this use case - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `params` GenerativeConfigParams - `type` 'OPENAI', required - `model` 'ANTHROPIC_CLAUDE_3_HAIKU_20240307_V1_0' | 'GPT_4O_MINI' - `temperature` number, double - `maxTokens` integer - `topP` number, double - `frequencyPenalty` number, double - `presencePenalty` number, double - `sources` Source[] - `name` string - `id` string - `definition` SourceDefinition - `name` string - `id` string - `type` string - `manualSyncAllowed` boolean - `configType` 'GOOGLE_DRIVE' | 'GOOGLE_DRIVE_V2' | 'SLACK' | 'CUSTOM' | 'GURU_IPAAS' | 'GSHEET' | 'MERGE_FILE' | 'MERGE_TICKET' | 'MERGE_CRM' | 'FILE_UPLOAD' - `requestAccess` boolean - `config` SourceDefinitionConfig - `discriminatorType` string - `mergeDevIntegrationName` string - `ipaasIntegrationId` string - `useSourceNameForFacet` boolean - `modelNames` object - `customDataStrategy` 'REMOTE_DATA' | 'REMOTE_FIELDS' - `supportsSourceNativePermissions` boolean - `sourceNativePermissionsRequireAdmin` boolean - `availability` 'NONE' | 'GENERAL' | 'TEAM' - `category` string - `iconUrl` string - `config` union - CustomSourceConfig - `type` 'CUSTOM', required - `name` string - `description` string - `iconUrl` string - `iconData` string - `iconMediaType` string - `specification` SourceApplicationSpecification - `application` Application - … - FileUploadSourceConfig - `type` 'FILE_UPLOAD', required - `name` string - `description` string - GSheetSourceConfig - `type` 'GSHEET', required - `documentUrl` string - `name` string - `description` string - `iconUrl` string - `objectName` string - `headerRow` integer - `idColumn` string - `titleColumn` string - `urlColumn` string - `iconData` string - `iconMediaType` string - `documentId` string - `sheetId` integer - GoogleDriveSourceConfig - `type` 'GOOGLE_DRIVE', required - `folderId` string - `folderName` string - GoogleDriveV2SourceConfig - `type` 'GOOGLE_DRIVE_V2', required - `folderId` string - `folderName` string - `honorAllowFileDiscovery` boolean - GuruIPaasSourceConfig - `type` 'GURU_IPAAS', required - `name` string - `description` string - `iconUrl` string - `instanceId` string - `integrationId` string - `iconData` string - `iconMediaType` string - `specification` SourceApplicationSpecification - `application` Application - … - MergeCRMSourceConfig - `type` 'MERGE_CRM', required - `tenant` string - MergeFileStorageSourceConfig - `type` 'MERGE_FILE', required - `folders` MergeFileStorageFolder[] - `id` string - `name` string - MergeTicketingSourceConfig - `type` 'MERGE_TICKET', required - SlackSourceConfig - `type` 'SLACK', required - `slackTeamName` string - `channelId` string - `channelName` string - `excludeBotMessages` boolean - `isPrivateChannel` boolean - `useTopMessageAsTitle` boolean - `lastSyncedDate` string, date-time - `statusReason` 'INVALID_AUTHENTICATION' | 'UNAUTHORIZED' | 'NO_API_ACCESS' | 'TARGET_INACCESSIBLE' | 'TOO_LARGE' | 'TARGET_INSECURE' | 'AUTH_EXPIRED' | 'MISSING_FEATURE' | 'API_ERROR' | 'NO_ADMIN' | 'API_TIMEOUT' | 'API_INTERRUPTED' | 'PARSING_ERROR' | 'EXTRACTION_ERROR' | 'HOMEBOARD_IMPORT_FAILED' | 'JOB_TIMEOUT' | 'UNKNOWN_ERROR' - `iconUrl` string - `lastSyncAttempt` string, date-time - `syncStatus` 'SYNCING' | 'SYNCED' | 'FAILED' | 'INVALID' - `connectionId` string - `authorizedBy` string - `sourceObjectTypes` ObjectType[] - `name` string - `fields` ObjectField[] - `name` string - `id` string - `contentSelector` string - `dataType` 'JSON' | 'TEXT' | 'HTML' | 'MARKDOWN' | 'MIXED_HTML_MARKDOWN' - `id` string - `externalId` string - `analyticsEnabled` boolean - `application` Application - `name` string - `id` string - `source` Source — recursive - `objectTypes` ObjectType[] - `relationships` Relationship[] - `name` string - `id` string - `type` 'ONE_TO_ONE' | 'ONE_TO_MANY' | 'MANY_TO_ONE' | 'MANY_TO_MANY' - `sourceObjectType` ObjectType — recursive - `mappedBy` 'SOURCE' | 'TARGET' - `sourceField` ObjectField - … - `sourceMetaField` 'OBJECT_TYPE' | 'EXTERNAL_ID' | 'EXTERNAL_URL' | 'TITLE' | 'JSON_CONTENT' | 'CONTENT' - `targetObjectType` ObjectType — recursive - `targetField` ObjectField - … - `targetMetaField` 'OBJECT_TYPE' | 'EXTERNAL_ID' | 'EXTERNAL_URL' | 'TITLE' | 'JSON_CONTENT' | 'CONTENT' - `dataType` 'JSON' | 'TEXT' | 'HTML' | 'MARKDOWN' | 'MIXED_HTML_MARKDOWN' - `sourceDataType` 'RECORD' | 'STRUCTURED' - `currentSyncNumber` integer - `templates` ObjectTypeTemplates - `objectTypeId` string - `cardTemplate` CardTemplate - `id` string - `content` string - `lastModified` string, date-time - `jsonContent` string - `cardTitle` string - `contentSchemaVersion` string - `templateTitle` string - `cardVerifier` union - … - `collection` CollectionModel - … - `lastModifiedBy` User - … - `boards` Folder[] - … - `shareStatus` 'PRIVATE' | 'TEAM' | 'PUBLIC' - `dateCreated` string, date-time - `createdBy` User - … - `verificationInterval` integer - `description` string - `tags` Tag[] - … - `externalUrlTemplate` string - `searchTemplate` string - `titleTemplate` string - `externalUrlTemplateType` 'SIMPLE' | 'FREEMARKER' - `titleTemplateType` 'SIMPLE' | 'FREEMARKER' - `orderByTemplate` string - `orderByTemplateType` 'SIMPLE' | 'FREEMARKER' - `orderByOrderType` 'ASC' | 'DESC' - `connectionName` string - `objectSyncs` SourceObjectSync[] - `objectType` ObjectType - `name` string - `fields` ObjectField[] - `name` string - `id` string - `contentSelector` string - `dataType` 'JSON' | 'TEXT' | 'HTML' | 'MARKDOWN' | 'MIXED_HTML_MARKDOWN' - `id` string - `externalId` string - `analyticsEnabled` boolean - `application` Application - `name` string - `id` string - `source` Source — recursive - `objectTypes` ObjectType[] - `relationships` Relationship[] - … - `dataType` 'JSON' | 'TEXT' | 'HTML' | 'MARKDOWN' | 'MIXED_HTML_MARKDOWN' - `sourceDataType` 'RECORD' | 'STRUCTURED' - `currentSyncNumber` integer - `templates` ObjectTypeTemplates - `objectTypeId` string - `cardTemplate` CardTemplate - … - `externalUrlTemplate` string - `searchTemplate` string - `titleTemplate` string - `externalUrlTemplateType` 'SIMPLE' | 'FREEMARKER' - `titleTemplateType` 'SIMPLE' | 'FREEMARKER' - `orderByTemplate` string - `orderByTemplateType` 'SIMPLE' | 'FREEMARKER' - `orderByOrderType` 'ASC' | 'DESC' - `lastSyncedDate` string, date-time - `statusReason` 'INVALID_AUTHENTICATION' | 'UNAUTHORIZED' | 'NO_API_ACCESS' | 'TARGET_INACCESSIBLE' | 'TOO_LARGE' | 'TARGET_INSECURE' | 'AUTH_EXPIRED' | 'MISSING_FEATURE' | 'API_ERROR' | 'NO_ADMIN' | 'API_TIMEOUT' | 'API_INTERRUPTED' | 'PARSING_ERROR' | 'EXTRACTION_ERROR' | 'HOMEBOARD_IMPORT_FAILED' | 'JOB_TIMEOUT' | 'UNKNOWN_ERROR' - `lastSyncAttempt` string, date-time - `syncStatus` 'SYNCING' | 'SYNCED' | 'FAILED' | 'INVALID' - `lastSyncCompleted` string, date-time - `objectCount` integer - `useSourceNativePermissions` boolean - `mergeIssues` LinkedAccountIssue[] - `id` string - `status` string - `errorDescription` string - `errorDetails` string[] - `muted` boolean - `firstIncidentTime` string, date-time - `lastIncidentTime` string, date-time - `userEmail` string - `integration` string - `team` Team - `name` string — Team Name - `id` string — ID of the fact - `profilePicUrl` string - `companyName` string — Team Company Name - `currentUserIsMember` boolean - `domain` string — Domain - `edition` TeamEdition - `adminOverrides` object - `name` string - `key` string - `id` string - `usage` object - `code` string - `features` object - `billableUsers` integer - `totalUsers` integer - `teamDomains` TeamDomain[] - `verificationCode` string - `verified` boolean - `capture` boolean - `domain` string - `slackCommandState` string - `slackCommandInstalled` boolean - `sfdcIntegrationState` string - `sfdcIntegrationInstalled` boolean - `clearProfilePic` boolean - `defaultGroup` UserGroup - `name` string — Group Name - `id` string — ID of the group - `members` UserGroupMember[] - `id` string — ID of the group member - `managedByScim` boolean - `dateCreated` string, date-time — Date the group member was added to the group. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `user` User, required - … - `expertIdRank` integer - `numberOfCardsAsVerifier` integer - `managedByScim` boolean - `groupIdentifier` string - `numberOfMembers` integer - `modifiable` boolean - `userModifiable` boolean - `singleUser` boolean - `team` Team — recursive - `dateCreated` string, date-time — Date the group was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `role` 'ADMIN' | 'AUTHOR' | 'MEMBER' | 'COLL_ADMIN' - `defaultUserType` 'FREE_CORE' | 'CORE' - `trialExpirationDate` string, date-time - `zendeskAssistState` string - `zendeskAssistInstalled` boolean - `zendeskKnowledgeState` string - `zendeskKnowledgeInstalled` boolean - `fileSharingDisabled` boolean - `collectionCreated` boolean - `teamCreationToken` string - `cardsCreated` integer - `topLevelOrganizationId` string - `numberOfCollections` integer - `numberOfOrgSharedCollections` integer - `allMembersGroupId` string - `deleted` boolean — Indicates if the fact has been deleted - `dateCreated` string, date-time — Date the team was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `userRole` string - `useCase` string - `description` string - `status` 'ACTIVE' | 'DORMANT' | 'LOCKED' | 'EXPIRED' | 'LOCKED_PAY' - `organization` Organization - `name` string - `id` string - `workspaces` Team[] - `createdBy` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - `description` string — A description of this use case - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `collections` CollectionModel[] - `name` string — Collection Name - `readOnly` boolean - `id` string — ID of the collection - `color` string — A hex value for the color of the Collection - `emoji` string - `slug` string — The slug is the URL to get to this Collection - `collectionStats` CollectionStats - `stats` object — Returns an object that includes the Collection Trust Score, and Card Count of the Collection. - `lastSyncedDate` string, date-time — The date that the Collection was last synced from the source - `topLevelSyncLocation` string — The URL where the content of the Collection is being synced from - `publicCards` integer - `madeByGuru` boolean - `homeBoardSlug` string - `syncType` 'ZENDESK' | 'ZENDESK_IMPORT' | 'CONFLUENCE' | 'MANUAL' | 'GOOGLE_DRIVE' | 'ZENEFITS' | 'BOX' | 'KUSTOMER' | 'DROPBOX' | 'SALESFORCE' | 'GURU' — If this Collection has been synced, this will return the type. Types include: Zendesk, Confluence, Google Drive, and Manual. - `deleted` boolean — Flag for whether this Collection has been deleted - `team` Team - `name` string — Team Name - `id` string — ID of the fact - `profilePicUrl` string - `companyName` string — Team Company Name - `currentUserIsMember` boolean - `domain` string — Domain - `edition` TeamEdition - `adminOverrides` object - `name` string - `key` string - `id` string - `usage` object - `code` string - `features` object - `billableUsers` integer - `totalUsers` integer - `teamDomains` TeamDomain[] - `verificationCode` string - `verified` boolean - `capture` boolean - `domain` string - `slackCommandState` string - `slackCommandInstalled` boolean - `sfdcIntegrationState` string - `sfdcIntegrationInstalled` boolean - `clearProfilePic` boolean - `defaultGroup` UserGroup - `name` string — Group Name - `id` string — ID of the group - `members` UserGroupMember[] - `id` string — ID of the group member - `managedByScim` boolean - `dateCreated` string, date-time — Date the group member was added to the group. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `user` User, required - … - `expertIdRank` integer - `numberOfCardsAsVerifier` integer - `managedByScim` boolean - `groupIdentifier` string - `numberOfMembers` integer - `modifiable` boolean - `userModifiable` boolean - `singleUser` boolean - `team` Team — recursive - `dateCreated` string, date-time — Date the group was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `role` 'ADMIN' | 'AUTHOR' | 'MEMBER' | 'COLL_ADMIN' - `defaultUserType` 'FREE_CORE' | 'CORE' - `trialExpirationDate` string, date-time - `zendeskAssistState` string - `zendeskAssistInstalled` boolean - `zendeskKnowledgeState` string - `zendeskKnowledgeInstalled` boolean - `fileSharingDisabled` boolean - `collectionCreated` boolean - `teamCreationToken` string - `cardsCreated` integer - `topLevelOrganizationId` string - `numberOfCollections` integer - `numberOfOrgSharedCollections` integer - `allMembersGroupId` string - `deleted` boolean — Indicates if the fact has been deleted - `dateCreated` string, date-time — Date the team was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000 - `userRole` string - `useCase` string - `description` string - `status` 'ACTIVE' | 'DORMANT' | 'LOCKED' | 'EXPIRED' | 'LOCKED_PAY' - `organization` Organization - `name` string - `id` string - `workspaces` Team[] - `defaultVerifier` string - `boards` integer — Number of boards in this Collection - `dateCreated` string, date-time — Date the collection was created - `collectionType` 'INTERNAL' | 'EXTERNAL' — The type can be either INTERNAL or EXTERNAL. EXTERNAL indicates that the card is from a synced Collection. - `publicCardsEnabled` boolean - `syncVerificationEnabled` boolean - `collectionTypeDetail` 'ONBOARDING' | 'FRAMEWORK' | 'USER' | 'EXTERNAL' | 'SOURCE' | 'WELCOME' | 'ONBOARDING_UNEDITED' — The type can be FRAMEWORK, ONBOARDING, USER or EXTERNAL. - `verificationInterval` integer - `cards` integer — Number of cards in this Collection - `administrator` boolean - `description` string — Collection Description - `tags` integer — Returns all Tag objects associated with this collection - `token` string - `dateCreated` string, date-time - `createdBy` User - `id` string — The identifier of this User - `profilePicUrl` string — The profile picture url for the user - `joinedDate` string, date-time - `userProfile` UserProfile — Specifies additional information about a Guru User - `roleLevel` string — The level at which the user operates in their current role - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru - `description` string — A description of this use case - `role` string — The functional role a Guru user performs on their team - `lastName` string, required — The user's last name - `firstName` string, required — The user's first name - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE. - `email` string, required — The user's email address - `isDefault` boolean - `useAllSources` boolean - `imageUrl` string - `urls` SearchAssistantUrl[] - `id` string, uuid - `name` string - `url` string - `assistants` SearchAssistant[] - `limitSlackResponsesToAllMembersContent` boolean - `legacyMode` boolean - `allowInSearchBar` boolean ## Other responses - `400` — Invalid/Incomplete Request - `401` — Request was unauthorized - `403` — Forbidden access to the resource - `404` — Resource could not be found --- [API](https://skmtc.net/getguru/apis/guru-api.md) · [All operations](https://skmtc.net/getguru/apis/guru-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getguru/guru-api/revisions/9090a01dfe1a/schema)