Socialboards
  • Developer hub
  • APIs
    • Ticket API
      • Getting Started
        • Guidelines and data privacy
      • Authorization
        • Access tokens
      • Categories
      • Custom Fields
      • Action Log
      • Notes
      • Replies
      • Tags
      • Tickets
      • Teammates
      • User Groups
      • Widgets
      • Webhooks
        • Getting Started
        • Create Endpoint
        • Configure the Webhooks
        • Testing your webhooks
      • Reference
        • Endpoints
          • Get Access Token v2
          • Get Full Community Category List
          • Get Subcategories by Parent Id
          • Get Category By Id
          • Get Full Community Custom Field List
          • Add Custom Field
          • Get Custom Field
          • Get All Teammates
          • Get All User Groups for Community
          • Update Custom Field
          • Delete Custom Field
          • Create Ticket
          • List Tickets
          • List Ticket Ids By Field Ids
          • Get Ticket by Id
          • Update Ticket Custom Field Value
          • Update Ticket Assignee
          • Get Ticket Log
          • Update Ticket Status
          • Update Ticket Category (Obsolete)
          • Update Ticket Category
          • Create Reply
          • List Replies
          • Add Note To Ticket
          • Update Note
          • Delete Note
          • List tags
          • Replace Ticket Tags
          • Replace Reply Tags
          • Get Widget Schedule List
        • API Request Result
        • Webhook Payload
        • Objects
          • Base Attachment
          • Category
          • Custom Field
          • Custom Field Id with Value
          • Custom Field Possible Value
          • Custom Field Value
          • Custom Times Widget Schedule
          • Note
          • Reply
          • Reply/Note Creator
          • Reply Properties
          • Schedule Time
          • Tag
          • Teammate
          • Ticket
          • Ticket Action Included Items
          • Ticket Creator
          • Ticket Id with Field Value
          • Ticket Log
          • Ticket Properties
          • User
          • User Group
          • Widget Schedule
        • Events
          • Ticket Creation
          • Ticket Status Change
          • Ticket Tags Change
          • Ticket Category Change
          • Reply Creation
          • Reply Update
          • Reply Deletion
          • Note Creation
          • Note Update
          • Note Deletion
        • Enumerations
          • Custom Field Types and Values Formats
          • Sentiment
          • Ticket Action Type
          • Ticket List Order By
          • Ticket Source
          • Ticket Status
          • User Role
          • Detailed Ticket Source
      • Glossary
    • External Chat API
      • Conversations Overview
      • Configure the Webhooks
      • Glossary
      • Reference
        • Endpoints
          • Create conversation
          • Add messages to conversation
          • Get conversation by id
          • List conversation messages
          • Get conversation queue information
          • Get takeover state
          • Change takeover state
          • Update conversation feedback
          • Update conversation latest url
          • Close conversation
        • Objects
          • Bot
          • Conversation
          • Conversation feedback
          • Conversation message
          • Conversation takeover
          • Conversation queue position
          • User
          • User Value
        • Events
          • Conversation created
          • Conversation Message Added
          • Conversation Takeover State Changed
          • Conversation Status Changed
        • Enumerations
          • Bot type
          • Order by
          • User status
          • Conversation Status
    • FAQ API
      • Glossary
      • Categories
      • FAQ Instances
      • Tags
      • Topics
      • Reference
        • Endpoints
          • List FAQ Instances
          • List Tags
          • List Categories
          • List Topics
          • Get Specific Topic
          • Add Vote to Topic
          • Increase View Count for Topic
          • Search Topics by Params
        • Objects
          • Attachment
          • Category
          • Instance
          • Tag
          • Topic
          • Topic Search Result
        • Enumerations
          • Localization Language
          • Template Type
          • Topic Downvote Reason
          • Topics Sort Options
    • Support Widget
      • Installation
      • Configuration options
      • Full script example
      • Javascript changelog
      • Widget schedule API
    • Reporting & Statistics
      • Data warehouse (DWH)
        • Entity relationship diagram (ERD)
        • Most used views and values
      • Reports and dashboards
  • Security
    • Introduction to Security
    • Data centers & network security
    • Product security features
    • Application security
    • Data Processing
    • Sub-Processors
      • 2023-04 Intility AS
        • Addendum 2023-4
  • Updates
    • Changelog
Powered by GitBook
On this page

Was this helpful?

  1. APIs
  2. FAQ API
  3. Reference
  4. Endpoints

List Topics

PreviousList CategoriesNextGet Specific Topic

Last updated 1 year ago

Was this helpful?

All API requests should contain .

Get all published topics by specified tag ids from the query parameters.

Request

GET faq/{faqName}/topics?tags={tags}&sortBy={sortBy}

Query Parameters

Name
Type
Required
Comments

faqName

string

yes

The name of the FAQ instance for the request

isSticky

nullable boolean

no

If set to false, it returns non-sticky topics only;

If set to true, it returns sticky topics only;

If set to null, it returns all topics. By default value is null

sortBy

no

The order of topics in the list. The default value is view_count_desc

tags

string

no

A string containing tag names separated by commas ,, used for fetching topics by their tag name(s). Each tag name is case-insensitive. By default value is null

Response

{
    "data": [
        {
            "isPublished": true,
            "link": "faq.socialboards.com/southsideblueroyaljewelry/category/450/product-information/topic/10002238/materials--craftsmanship",
            "publishTime": "2023-12-19T11:52:33.4978547+00:00",
            "usefulCount": 1,
            "attachments": [],
            "bannerImageLink": null,
            "category": {
                "activeTopicCount": 3,
                "creationTime": "2023-12-19T11:45:11.6741421+00:00",
                "creatorId": "dd5a1046-98c7-4e12-9bc4-1c5aa35cf403",
                "description": "Explore our exquisite collection and learn about our jewelry materials, designs, and craftsmanship to help you make informed purchasing decisions.",
                "id": 450,
                "imageLink": null,
                "isPublished": true,
                "isSticky": true,
                "lastUpdateTime": "2023-12-21T08:29:56.4630697+00:00",
                "publishedTopicCount": 3,
                "title": "Product Information",
                "totalUsefulness": 2,
                "viewCount": 13
            },
            "content": "<p><strong>1. Fine Materials</strong>:</p><ul><li><p><strong>Precious Metals</strong>: Our jewelry is crafted using the finest materials, including 18K and 24K gold, platinum, and sterling silver. We adhere to strict quality standards, ensuring each piece meets the highest benchmarks of purity and durability.</p></li><li><p><strong>Exquisite Gemstones</strong>: From dazzling diamonds to vibrant rubies, sapphires, emeralds, and other rare gemstones, we source our stones from ethical suppliers to guarantee authenticity and brilliance.</p></li></ul><p><strong>2. Craftsmanship &amp; Artistry</strong>:</p><ul><li><p><strong>Artisanal Expertise</strong>: Our master artisans, with decades of experience, meticulously handcraft each piece with unwavering attention to detail. Their skillful hands bring to life intricate designs and ensure the highest level of quality in every creation.</p></li><li><p><strong>Innovative Techniques</strong>: Embracing traditional techniques alongside modern innovations, our craftsmen employ cutting-edge technology combined with time-honored methods, resulting in jewelry that is both timeless and contemporary.</p></li></ul><p><strong>3. Quality Assurance</strong>:</p><ul><li><p><strong>Rigorous Standards</strong>: Every piece undergoes stringent quality checks at multiple stages of production, ensuring that it meets our exacting standards of craftsmanship, finish, and durability.</p></li><li><p><strong>Lifetime Guarantee</strong>: We stand behind the quality of our jewelry. Each piece comes with a lifetime guarantee, assuring you of its exceptional craftsmanship and materials.</p></li></ul><p><strong>4. Sustainable Practices</strong>:</p><ul><li><p><strong>Ethical Sourcing</strong>: We are committed to responsible sourcing, working with suppliers who adhere to ethical practices, including fair wages and environmentally conscious mining.</p></li><li><p><strong>Environmental Consciousness</strong>: Our efforts extend to minimizing our environmental impact by employing eco-friendly practices in our production processes whenever possible.</p></li></ul><p><strong>5. Customization &amp; Personalization</strong>:</p><ul><li>Beyond our curated collections, we offer customization services, allowing you to create bespoke pieces tailored to your individual preferences, ensuring a truly unique and personalized experience.</li></ul>",
            "creationTime": "2023-12-19T11:52:33.4845556+00:00",
            "description": "At Socialboards Jewelry Store, our commitment to excellence starts with the materials we select and the meticulous craftsmanship that goes into creating each piece of fine jewelry.",
            "id": 10002238,
            "isSticky": true,
            "lastUpdateTime": "2023-12-21T13:19:33.0283016+00:00",
            "logoLink": null,
            "tableOfContents": "[]",
            "tags": [
                {
                    "id": 444,
                    "name": "Support"
                }
            ],
            "title": "Materials & Craftsmanship",
            "totalUsefulness": 1,
            "viewCount": 4
        },
        {
            "isPublished": true,
            "link": "faq.socialboards.com/southsideblueroyaljewelry/category/451/ordering--services/topic/10002240/ordering-process--tracking",
            "publishTime": "2023-12-19T14:41:53.5337784+00:00",
            "usefulCount": 2,
            "attachments": [],
            "bannerImageLink": null,
            "category": {
                "activeTopicCount": 3,
                "creationTime": "2023-12-19T14:27:42.1864607+00:00",
                "creatorId": "dd5a1046-98c7-4e12-9bc4-1c5aa35cf403",
                "description": "Understand our ordering process, shipping options, customization services, repair, appraisals, and other services we offer to ensure a seamless shopping experience.",
                "id": 451,
                "imageLink": null,
                "isPublished": true,
                "isSticky": true,
                "lastUpdateTime": "2023-12-21T08:29:55.4943982+00:00",
                "publishedTopicCount": 3,
                "title": "Ordering & Services",
                "totalUsefulness": 0,
                "viewCount": 42
            },
            "content": "<p><strong>Ordering Process &amp; Tracking</strong></p><p>Experience a seamless and convenient ordering journey with [Jewelry Store Name]. We've streamlined our ordering process to ensure a hassle-free experience from selection to delivery, along with easy tracking options for your peace of mind.</p><p><strong>1. Placing Your Order</strong>:</p><ul><li><p><strong>Online Shopping Convenience</strong>: Browse our curated collections and select your desired jewelry pieces easily through our user-friendly website or mobile app.</p></li><li><p><strong>Simple Checkout Process</strong>: Proceed to the secure checkout, where you can review your order, enter shipping details, and select preferred payment methods before confirming your purchase.</p></li></ul><p><strong>2. Order Confirmation &amp; Updates</strong>:</p><ul><li><p><strong>Confirmation Email</strong>: Receive an immediate order confirmation via email, providing essential details such as order number, items purchased, and estimated delivery time.</p></li><li><p><strong>Regular Updates</strong>: Stay informed about your order status with regular updates sent via email or SMS, from order processing to shipment preparation and dispatch.</p></li></ul><p><strong>3. Tracking Your Shipment</strong>:</p><ul><li><p><strong>Shipment Tracking Information</strong>: Once your order is shipped, you'll receive a tracking number along with instructions on how to track your package in real-time.</p></li><li><p><strong>Online Tracking Portal</strong>: Visit our website or use our dedicated tracking portal to monitor the progress of your shipment, ensuring you're always aware of its location and expected delivery date.</p></li></ul><p><strong>4. Customer Support Assistance</strong>:</p><ul><li><p><strong>Dedicated Support Team</strong>: Should you have any inquiries or need assistance, our dedicated customer support team is available to address your concerns regarding orders, tracking, or delivery.</p></li><li><p><strong>Contact Options</strong>: Reach out to us via phone, email, or live chat for immediate assistance during our business hours, ensuring a swift resolution to any queries you may have.</p></li></ul><p><strong>5. Returns and Order Modifications</strong>:</p><ul><li><p><strong>Easy Returns</strong>: In the event you need to return or exchange your order, refer to our clear and accessible return policy for instructions on initiating the process.</p></li><li><p><strong>Modifications and Adjustments</strong>: For order modifications or special requests, contact our support team promptly to assist you in making necessary adjustments before shipment.</p></li></ul>",
            "creationTime": "2023-12-19T14:41:53.5257164+00:00",
            "description": " Understand how to place orders, track shipments, and manage your purchases through our platform.",
            "id": 10002240,
            "isSticky": true,
            "lastUpdateTime": "2023-12-21T14:18:27.4249709+00:00",
            "logoLink": null,
            "tableOfContents": "[]",
            "tags": [
                {
                    "id": 444,
                    "name": "Support"
                }
            ],
            "title": "Ordering Process & Tracking",
            "totalUsefulness": 0,
            "viewCount": 41
        },
        {
            "isPublished": true,
            "link": "faq.socialboards.com/southsideblueroyaljewelry/category/452/policies--support/topic/10002243/payment-methods--installment-plans",
            "publishTime": "2023-12-19T14:42:57.563867+00:00",
            "usefulCount": 0,
            "attachments": [],
            "bannerImageLink": null,
            "category": {
                "activeTopicCount": 1,
                "creationTime": "2023-12-19T14:28:09.7019105+00:00",
                "creatorId": "dd5a1046-98c7-4e12-9bc4-1c5aa35cf403",
                "description": "Learn about our payment methods, return policies, store locations, and how to contact our dedicated customer support team for any inquiries or assistance",
                "id": 452,
                "imageLink": null,
                "isPublished": true,
                "isSticky": true,
                "lastUpdateTime": "2023-12-21T08:29:55.7316364+00:00",
                "publishedTopicCount": 1,
                "title": "Policies & Support",
                "totalUsefulness": 0,
                "viewCount": 0
            },
            "content": "<p>At [Jewelry Store Name], we offer flexible payment options to make your purchase experience convenient and tailored to your preferences. Explore our diverse range of payment methods and installment plans designed to accommodate your needs.</p><p><strong>1. Accepted Payment Methods</strong>:</p><ul><li><p><strong>Credit &amp; Debit Cards</strong>: We accept major credit cards such as Visa, Mastercard, American Express, and Discover, providing a secure and straightforward payment process.</p></li><li><p><strong>Online Payment Gateways</strong>: Simplify your transactions by using trusted online payment gateways like PayPal or other secure platforms for hassle-free purchases.</p></li></ul><p><strong>2. Bank Transfers and Wire Transfers</strong>:</p><ul><li><p><strong>Bank-to-Bank Transfers</strong>: Opt for direct bank transfers or wire transfers for larger purchases, ensuring a seamless transaction process.</p></li><li><p><strong>Instructions Provided</strong>: Contact our customer service for detailed instructions on how to proceed with bank transfers to complete your payment.</p></li></ul><p><strong>3. Installment and Payment Plans</strong>:</p><ul><li><p><strong>Flexible Installments</strong>: Benefit from our installment plans allowing you to spread the cost of your purchase over a set period, making high-value purchases more manageable.</p></li><li><p><strong>Customizable Plans</strong>: Discuss personalized installment options with our team to tailor a payment plan that suits your financial preferences and the specifics of your purchase.</p></li></ul><p><strong>4. Secure Transactions &amp; Privacy</strong>:</p><ul><li><p><strong>Safe and Secure Transactions</strong>: Rest assured, all payment methods and transactions adhere to the highest security standards to protect your sensitive information.</p></li><li><p><strong>Privacy Protection</strong>: We prioritize customer privacy and confidentiality, ensuring that your payment details are handled securely and with the utmost discretion.</p></li></ul><p><strong>5. Terms and Conditions</strong>:</p><ul><li><p><strong>Clear Terms</strong>: Review the terms and conditions associated with different payment methods and installment plans to understand the applicable fees, interest rates (if any), and repayment schedules.</p></li><li><p><strong>Transparency</strong>: We maintain transparency in our payment processes, providing clear information to facilitate informed decisions regarding your purchases and payments.</p></li></ul><p><strong>6. Assistance and Inquiries</strong>:</p><ul><li><strong>Payment Assistance</strong>: Should you require guidance or have inquiries regarding payment methods or installment plans, our customer service team is available to assist you.</li></ul>",
            "creationTime": "2023-12-19T14:42:51.9941409+00:00",
            "description": "Details about accepted payment methods, security measures, and the availability of installment/payment plans",
            "id": 10002243,
            "isSticky": true,
            "lastUpdateTime": "2023-12-21T13:40:38.0697042+00:00",
            "logoLink": "",
            "tableOfContents": "[]",
            "tags": [
                {
                    "id": 444,
                    "name": "Support"
                }
            ],
            "title": "Payment Methods & Installment Plans",
            "totalUsefulness": 0,
            "viewCount": 0
        }
    ],
    "errorCode": -1,
    "errorText": null
}

enumeration

Data field will contain an array of objects.

authorization headers
Topic
Topics Sort Options