Skip to content
API Reference/
/
Get All Faq Items

Get All Faq Items

Request

Get all faq items the current API user can manage. To specify faq items with identifier please provide ?identifier= in the URL param By default, 50 are returned, you can use up to max=10000 in the URL param

Security
X-API-KEY or Authorization
curl -i -X GET \
  https://uberall.com/api/faq \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Faq Items successfully retrieved

Body*/*
statusstringrequired
Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "offset": 0,
    "max": 10,
    "total": 100,
    "faqItems": [
      {
        "id": 0,
        "question": "Do you have parking?",
        "answer": "Yes, free valet parking is available.",
        "identifier": "string",
        "listName": "string",
        "translations": {
          "property1": {
            "property1": "string",
            "property2": "string"
          },
          "property2": {
            "property1": "string",
            "property2": "string"
          }
        }
      }
    ]
  }
}