Get all Topics

To retreive all the topics.

info

{api-base-url} can be obtained from the MirrorFly console.

HTTP request#

curl -X GET 'https://{api-base-url}/api/v1/chat/topics/all?userId=XXXXX' \
--header 'accept: */*' \
--header 'Authorization: :AuthToken'

Request Params#

Param	DataType	Required	Description
userId	String	No	Retrieves topics associated with the current user license key and optionally specified User ID

Responses#

If successful, this action returns topic data's in the response body.

{
  "status": 200,
  "data": {
    "topics": [
      {
        "topicName": "Year end sale", // some name given to the topic
        "topicId": "xxx1", // unique id generated for the topic
        "licenseKey": "xxxxxx",
        "metaData": {
          // metadata key/value if any set
        }
      }
    ]
  },
  "message": "Data retrieved successfully"
}

Error#

In the case of an error, an error object like below is returned.

When the token passed in Headers is expired

{
    "status": 401,
    "message": "Token Expired"
}

In the case of a Bad Request, an error message is returned

{
    "status": 400,
    "message": "Error Message"
}