search

Get FAQ Content API

The Get FAQ API Content API helps you to get you the content of the FAQ against the Category Id.

hashtag
Get FAQ Content.

POST https://<sub domain>.kapturecrm.com/get-faq-contents.htmlarrow-up-right arrow-up-right

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

hashtag
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>

hashtag
Request Body

The request body should be a JSON object containing the details of the FAQ Contents to be fetched. Here are the list of parameters.

Name
Mandatory
Data Field
Description

Category Id

Yes

category_id

FAQ Contents to be searched based on category id. To get the system category ids, we can use the FAQ Category API

Start Date & End Date

No

start_date, end_date

Date the FAQ content was created IN yyyy-mm-dd format

Employee Id

No

employee_id

FAQ Contents created by

Start Index, End Index

Yes

start_index, end_index

Since FAQ contents are huge data, so it is recommended to use start index and end index. By default start index will be 0 and end index will be 20

[
    {
        "employee_id": "",
        "category_id": "5247",
        "start_index": "0",
        "end_index": "20"
    }
]

hashtag
Response Body

The API responds with a JSON object containing the details of the all the contents inside that FAQ Category. If successful, the response will include the category ID 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

hashtag
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

hashtag
Example of a working curl

PreviousPull Order APINextGet FAQ Category API

Last updated