### Guru API Getting Started Guide Source: https://developer.getguru.com/reference/getv1templatesgettemplate Provides essential information for developers to begin integrating with the Guru API. Covers authentication methods, API token management, and pagination strategies for efficient data retrieval. ```APIDOC Guru API - Getting Started This section guides you through the initial steps of using the Guru API. 1. **Authentication**: * **Overview**: Details the authentication protocols and security measures employed by the Guru API. * **API Tokens**: Instructions on how to generate, manage, and utilize API tokens for secure access to the API. * **Endpoint**: `/reference/tokens` * **Purpose**: Create, list, and revoke API tokens. * **Methods**: POST (create), GET (list), DELETE (revoke). * **Parameters**: May require existing credentials or API keys for token generation. * **Returns**: API token string, expiration timestamps, and associated permissions. * **Example**: `POST /v1/tokens` with `{"apiKey": "YOUR_API_KEY"}` might return `{"token": "YOUR_GENERATED_TOKEN", "expires_in": 3600}`. 2. **Pagination**: * **Overview**: Explains how to handle large datasets by implementing pagination. Details parameters like `page` and `limit` or cursor-based pagination. * **Endpoint**: `/reference/paging-1` * **Purpose**: Efficiently retrieve data in manageable chunks. * **Parameters**: Common parameters include `limit` (items per page) and `offset` or `page` (page number). * **Returns**: Data arrays and metadata for navigation (e.g., `next_page_url`, `total_items`). * **Example**: `GET /v1/items?limit=20&page=2` retrieves the second page of items, with 20 items per page. ``` -------------------------------- ### API Getting Started & Concepts Source: https://developer.getguru.com/reference/postv1teamstagcategoriescreatetag Guides for new users of the Guru API, covering essential concepts like authentication, API tokens, and pagination strategies for efficient data retrieval. ```APIDOC Overview: - Provides a general introduction to the Guru API and its capabilities. API Tokens: - Explains how to generate, manage, and use API tokens for authentication. - Details security best practices for token handling. Pagination: - Describes the methods used for paginating API responses to handle large datasets. - Includes parameters for controlling page size and navigating through results. ``` -------------------------------- ### Get a Card Template Example Source: https://developer.getguru.com/reference/getv1templatesgettemplate Example of how to retrieve a specific card template using the Guru API. ```Shell curl -X GET \ https://api.getguru.com/api/v1/templates/cards/{templateId} \ -H 'Authorization: Basic ' ``` -------------------------------- ### Getting Started with Guru API Source: https://developer.getguru.com/reference/getv1foldersgetparentfolder This section outlines the initial steps for using the Guru API, including an overview of authentication mechanisms and API token management. ```APIDOC API Reference - Getting Started Overview: - Provides a general introduction to the Guru API and its capabilities. API Tokens: - Details on how to generate, manage, and use API tokens for authentication. - Includes information on token scopes and security best practices. Pagination: - Explains how to handle paginated responses from the API. - Covers parameters for controlling page size and navigating through results. ``` -------------------------------- ### Get a Card Template Example Source: https://developer.getguru.com/reference/getv1templatesgettemplate Example of how to retrieve a specific card template using the Guru API. ```Ruby require 'httparty' template_id = 'YOUR_TEMPLATE_ID' credentials = Base64.strict_encode64('username:password') response = HTTParty.get("https://api.getguru.com/api/v1/templates/cards/#{template_id}", headers: { 'Authorization' => "Basic #{credentials}" } ) puts response.body ``` -------------------------------- ### Getting Started with Guru API Source: https://developer.getguru.com/reference/getv1cardscommentsgetcomments This section outlines the initial steps and concepts required to begin using the Guru API. It includes information on authentication methods, API token management, and how to handle paginated responses. ```APIDOC API Reference Sections: Overview: - Provides a general introduction to the Guru API and its capabilities. API Tokens: - Details on how to generate, manage, and use API tokens for authentication. - Includes information on token scopes and security best practices. Pagination: - Explains the mechanisms used for paginating results from API endpoints. - Covers parameters for controlling page size, offset, and navigating through large datasets. ``` -------------------------------- ### Get a Card Template Example Source: https://developer.getguru.com/reference/getv1templatesgettemplate Example of how to retrieve a specific card template using the Guru API. ```Python import requests import base64 template_id = 'YOUR_TEMPLATE_ID' username = 'your_username' password = 'your_password' credentials = f'{username}:{password}' encoded_credentials = base64.b64encode(credentials.encode()).decode() url = f'https://api.getguru.com/api/v1/templates/cards/{template_id}' headers = { 'Authorization': f'Basic {encoded_credentials}' } response = requests.get(url, headers=headers) if response.status_code == 200: print(response.json()) else: print(f'Error: {response.status_code} - {response.text}') ``` -------------------------------- ### Get a Card Template Example Source: https://developer.getguru.com/reference/getv1templatesgettemplate Example of how to retrieve a specific card template using the Guru API. ```Node const axios = require('axios'); const templateId = 'YOUR_TEMPLATE_ID'; const credentials = Buffer.from('username:password').toString('base64'); axios.get(`https://api.getguru.com/api/v1/templates/cards/${templateId}`, { headers: { 'Authorization': `Basic ${credentials}` } }) .then(response => { console.log(response.data); }) .catch(error => { console.error('Error fetching template:', error); }); ``` -------------------------------- ### Get a Card Template Example Source: https://developer.getguru.com/reference/getv1templatesgettemplate Example of how to retrieve a specific card template using the Guru API. ```PHP ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/postv1folderscreatenewfolder Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Example: Fetching Next Page of Search Results Source: https://developer.getguru.com/reference/paging-1 Demonstrates how to use `curl` to fetch the next page of results from an API endpoint, following the pagination guidance provided by the `Link` header. ```curl curl https://api.getguru.com/api/v1/search/query?token=xsfwsgsgi248rhfn2oir987kjowidjf9w87et9w8etwt ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/putv1templatesupdatetemplate Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/postv1templatescreatetemplate Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/getv1foldersgetfolders Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/getv1foldersgetfolder Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/getv1assistantsgetassistants Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### API Reference Sections Source: https://developer.getguru.com/reference/deletev1groupsdeleteusergroupmember Provides an overview of the API structure, including sections for getting started, authentication, API tokens, pagination, and specific operations like managing user group members. ```APIDOC API Reference: - Getting Started: - Overview - API Tokens - Pagination - Specific Operations: - Delete a user group member ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/putv1kcsaddkcsapp Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/getv1kcsgetkcsapps Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/getv1foldersgetfolderpermissions Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/getv1foldersgetfolderitems Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/getv1foldersgetparentfolder Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/putv1foldersupdatefolder Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/getv1foldersgetfolderaspdf Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/paging-1 Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/getv1peoplegetperson Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Create Ticket Link Source: https://developer.getguru.com/reference/postv1kcscreatekcs Example code for creating a ticket link using the Guru API. This endpoint requires authentication and allows for the creation of ticket links, which can be useful for integrating with external ticketing systems. ```Shell curl -X POST \ https://api.getguru.com/api/v1/kcs \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic YOUR_BASE64_ENCODED_CREDENTIALS' \ -d '{ "content": "Your ticket details here" }' ``` ```Node const axios = require('axios'); const createTicketLink = async (content, credentials) => { const response = await axios.post('https://api.getguru.com/api/v1/kcs', { content: content }, { headers: { 'Content-Type': 'application/json', 'Authorization': `Basic ${credentials}` } }); return response.data; }; // Example usage: // createTicketLink('Ticket details', 'YOUR_BASE64_ENCODED_CREDENTIALS') // .then(data => console.log(data)) // .catch(error => console.error(error)); ``` ```Ruby require 'httparty' class GuruAPI include HTTParty base_uri 'https://api.getguru.com' def initialize(credentials) @credentials = credentials end def create_ticket_link(content) self.class.post('/api/v1/kcs', body: { content: content }.to_json, headers: { 'Content-Type' => 'application/json', 'Authorization' => "Basic #{@credentials}" } ) end end # Example usage: # api = GuruAPI.new('YOUR_BASE64_ENCODED_CREDENTIALS') # response = api.create_ticket_link('Ticket details') # puts response ``` ```PHP $content]); $ch = curl_init($url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, $data); curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); $response = curl_exec($ch); if (curl_errno($ch)) { echo 'Curl error: ' . curl_error($ch); } curl_close($ch); return json_decode($response, true); } // Example usage: // $response = createGuruTicketLink('Ticket details', 'YOUR_BASE64_ENCODED_CREDENTIALS'); // print_r($response); ?> ``` ```Python import requests def create_ticket_link(content, credentials): url = 'https://api.getguru.com/api/v1/kcs' headers = { 'Content-Type': 'application/json', 'Authorization': f'Basic {credentials}' } payload = { 'content': content } response = requests.post(url, json=payload, headers=headers) response.raise_for_status() # Raise an exception for bad status codes return response.json() # Example usage: # try: # data = create_ticket_link('Ticket details', 'YOUR_BASE64_ENCODED_CREDENTIALS') # print(data) # except requests.exceptions.RequestException as e: # print(f'Error: {e}') ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/index Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/getv1templatesgetalltemplatesbyteam Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/getv1cardsverifiersgetverifiers Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/getv1foldersfoldersearch Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### WhoAmI API Source: https://developer.getguru.com/reference/getv1foldersgetfolders Endpoint for retrieving current user information. ```APIDOC GET /api/v1/whoami/whoami Retrieves information about the currently authenticated user. Returns details such as user ID, name, and email. ``` -------------------------------- ### GET /api/v1/whoami/whoami - Get User Information Source: https://developer.getguru.com/reference/getv1membersgetteammembers Retrieves information about the currently authenticated user. This endpoint is useful for identifying the logged-in user and accessing their profile details. ```APIDOC GET https://api.getguru.com/api/v1/whoami/whoami Description: Returns information about the currently authenticated user. Authentication: Required (Basic or API Key). Parameters: None. Returns: An object containing the current user's details, such as ID, name, email, and role. ``` -------------------------------- ### WhoAmI API Source: https://developer.getguru.com/reference/getv1foldersgetfolder Endpoint for retrieving current user information. ```APIDOC GET /reference/getv1whoamiwhoami - Retrieves information about the authenticated user. ``` -------------------------------- ### Teams API Operations Source: https://developer.getguru.com/reference/deletev1kcsdeletekcs Provides an endpoint to get statistics for a specific team. ```APIDOC GET /reference/getv1teamsgetteamstats Description: Fetches statistical data related to a team. Parameters: (The source text does not specify how to identify the team for which stats are requested.) Response: (The format of the team statistics is not described.) ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/getv1foldersgeteffectivepermissions Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Get Announcement User Stats Source: https://developer.getguru.com/reference/getv1alertsgetalertstatusers Retrieves user statistics for a specific announcement. Requires basic authentication. ```APIDOC GET https://api.getguru.com/api/v1/alerts/{alertId}/stats/users --- **Description:** Retrieves user statistics for a specific announcement. **Endpoint:** `/api/v1/alerts/{alertId}/stats/users` **Method:** GET **Parameters:** - `alertId` (Path Parameter, string): The unique identifier for the alert. **Authentication:** Basic authentication (base64 encoded). **Response:** Returns user statistics for the specified alert. The exact structure of the response is not detailed here but is available via interactive testing. **Example Usage (Conceptual):** * **Shell:** ```bash curl -u "YOUR_EMAIL:YOUR_PASSWORD" https://api.getguru.com/api/v1/alerts/{alertId}/stats/users ``` * **Node.js:** ```javascript const axios = require('axios'); const credentials = Buffer.from('YOUR_EMAIL:YOUR_PASSWORD').toString('base64'); axios.get('https://api.getguru.com/api/v1/alerts/{alertId}/stats/users', { headers: { 'Authorization': `Basic ${credentials}` } }) .then(response => { console.log(response.data); }) .catch(error => { console.error(error); }); ``` * **Python:** ```python import requests from requests.auth import HTTPBasicAuth auth = HTTPBasicAuth('YOUR_EMAIL', 'YOUR_PASSWORD') response = requests.get('https://api.getguru.com/api/v1/alerts/{alertId}/stats/users', auth=auth) print(response.json()) ``` **Related Endpoints:** - Other endpoints for managing alerts or user data would typically be found in separate sections of the API documentation. ``` -------------------------------- ### WhoAmI API Source: https://developer.getguru.com/reference/postv1folderscreatenewfolder API endpoint for retrieving current user information. ```APIDOC GET /reference/getv1whoamiwhoami Description: Retrieves information about the currently authenticated user. ``` -------------------------------- ### Folder Creation API Source: https://developer.getguru.com/reference/postv1folderscreatenewfolder API endpoint to create a new folder. Requires a title and supports Basic authentication. ```APIDOC POST /api/v1/folders Description: Creates a new folder. Parameters: - Title: string (required) - The name of the folder. Authentication: Basic (base64 encoded) Example Usage: curl -X POST \ https://api.getguru.com/api/v1/folders \ -H "Authorization: Basic " \ -d '{"title": "My New Folder"}' Response: Details of the created folder. ``` -------------------------------- ### Get User Profile Source: https://developer.getguru.com/reference/getv1peoplegetperson Retrieves detailed information for a specific user profile using their ID. Requires Basic Authentication. ```Shell curl -X GET \ https://api.getguru.com/api/v1/people/{id} \ -H 'Authorization: Basic ' ``` ```Node const axios = require('axios'); const userId = 'some_user_id'; const credentials = Buffer.from('username:password').toString('base64'); axios.get(`https://api.getguru.com/api/v1/people/${userId}`, { headers: { 'Authorization': `Basic ${credentials}` } }) .then(response => { console.log(response.data); }) .catch(error => { console.error('Error fetching user profile:', error); }); ``` ```Ruby require 'httparty' user_id = 'some_user_id' credentials = Base64.strict_encode64('username:password') response = HTTParty.get("https://api.getguru.com/api/v1/people/#{user_id}", headers: { 'Authorization' => "Basic #{credentials}" }) puts response.body ``` ```PHP ``` ```Python import requests import base64 user_id = 'some_user_id' username = 'your_username' password = 'your_password' credentials = f'{username}:{password}' encoded_credentials = base64.b64encode(credentials.encode()).decode() headers = { 'Authorization': f'Basic {encoded_credentials}' } response = requests.get(f'https://api.getguru.com/api/v1/people/{user_id}', headers=headers) if response.status_code == 200: print(response.json()) else: print(f'Error: {response.status_code} - {response.text}') ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/getv1cardsverifiersgetverifier Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Get Knowledge Assistants API Source: https://developer.getguru.com/reference/getv1assistantsgetassistants Retrieves a list of knowledge assistants available via the API. This endpoint requires authentication. ```Shell curl -X GET https://api.getguru.com/api/v1/assistants \ -H "Authorization: Basic YOUR_BASE64_ENCODED_CREDENTIALS" ``` ```Node const axios = require('axios'); const getAssistants = async () => { try { const response = await axios.get('https://api.getguru.com/api/v1/assistants', { headers: { 'Authorization': 'Basic YOUR_BASE64_ENCODED_CREDENTIALS' } }); console.log(response.data); } catch (error) { console.error('Error fetching assistants:', error); } }; getAssistants(); ``` ```Ruby require 'httparty' response = HTTParty.get('https://api.getguru.com/api/v1/assistants', headers: { 'Authorization' => 'Basic YOUR_BASE64_ENCODED_CREDENTIALS' }) puts response.body ``` ```PHP ``` ```Python import requests url = "https://api.getguru.com/api/v1/assistants" headers = { "Authorization": "Basic YOUR_BASE64_ENCODED_CREDENTIALS" } try: response = requests.get(url, headers=headers) response.raise_for_status() # Raise an exception for bad status codes print(response.json()) except requests.exceptions.RequestException as e: print(f"Error fetching assistants: {e}") ``` -------------------------------- ### Search API Source: https://developer.getguru.com/reference/getv1foldersgetfolder Provides endpoints for searching within Guru, supporting keyword searches, JSON queries, and source-based searches. ```APIDOC Search API Search for cards GET /v1/search/querysearchcardmgr Searches for cards using keyword-based queries. Parameters: (Query Parameters) Search query. Returns: A list of matching card objects. Search for cards using JSON query POST /v1/search/querysearchbyjsonforcardmanager Searches for cards using a structured JSON query. Parameters: (Request Body) JSON query object. Returns: A list of matching card objects. Search with Sources POST /v1/search/keyworddocumentsearch Performs a search across specified sources. Parameters: (Request Body) Search query and source filters. Returns: Search results. Search for cards (general) GET /v1/search/querysearch Performs a general search for cards. Parameters: (Query Parameters) Search query. Returns: A list of matching card objects. ``` -------------------------------- ### Tags API Source: https://developer.getguru.com/reference/authentication Manages tags and tag categories within Guru, including getting, creating, updating tags, and listing tag categories. ```APIDOC Tags API Get a tag GET /v1/teams/tagcategories/gettag Retrieves details for a specific tag. Parameters: (Query Parameters) Tag ID. Returns: The tag object. Create a tag POST /v1/teams/tagcategories/createtag Creates a new tag. Parameters: (Request Body) Tag name and category. Returns: The created tag object. Update a tag PUT /v1/teams/tagcategories/updatetag Updates an existing tag. Parameters: (Request Body) Tag ID and updated details. Returns: The updated tag object. List tag categories GET /v1/teams/tagcategories/gettagcategories Retrieves a list of all available tag categories. Parameters: None specified. Returns: A list of tag category objects. ``` -------------------------------- ### Search API Source: https://developer.getguru.com/reference/getv1foldersgetfolders Provides endpoints for searching within Guru, supporting keyword searches, JSON queries, and source-based searches. ```APIDOC Search API Search for cards GET /v1/search/querysearchcardmgr Searches for cards using keyword-based queries. Parameters: (Query Parameters) Search query. Returns: A list of matching card objects. Search for cards using JSON query POST /v1/search/querysearchbyjsonforcardmanager Searches for cards using a structured JSON query. Parameters: (Request Body) JSON query object. Returns: A list of matching card objects. Search with Sources POST /v1/search/keyworddocumentsearch Performs a search across specified sources. Parameters: (Request Body) Search query and source filters. Returns: Search results. Search for cards (general) GET /v1/search/querysearch Performs a general search for cards. Parameters: (Query Parameters) Search query. Returns: A list of matching card objects. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.