Search FAQ Content API

The Search FAQ Content API will help you get the contents related to the title provided.

Search FAQ Content.

POST https://kms-<sub domain>.kapturecrm.com/search-faq-contents.html

NOTE: Please replace with your sub domain name in the API.

Authentication:

To access this API endpoint, you need to include your API key in the request headers. For authentication, use the following header:

Basic <Your Token>

Request Body

There will be only one single parameter which will give you the content related to that specific FAQ

Name
Mandatory
Data Field
Description

Search

Yes

search_key

Search key takes the input of the title against which we need to seach the relevant contents for

[
    {
        "search_key": "Metal"
    }
]

Response Body

The API responds with a JSON object containing the details of the all the contents inside that FAQ Title. If successful, the response will include the contents and the other relevant information.

Response
Response Messages

{ ..., "status": "success"}

List of customers fetched successfully.

{"message": "Invalid Auth Key","status": "failed"}

Authorization key is either not passed in header, or incorrect, or expired/disabled

Error Codes

Error Codes
Description

400

Bad Request - Invalid parameters or missing data

401

Unauthorized - Invalid or missing API key

403

Forbidden - Insufficient permissions

404

Not Found - Resource or endpoint not found

500

Internal Server Error - Server-side issue

Example of a working curl

Last updated

Was this helpful?