Question answers

List Question Answers

Lists a collection of question-answers.

GET
/question-answers.list

Authorization

AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

Query Parameters

applies_to_articles?array<string>

Filters for question-answer belonging to any of the provided articles.

applies_to_parts?array<string>

Filters for question-answer belonging to any of the provided parts.

created_by?array<string>

Filters for question-answers created by any of the provided users.

cursor?string

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

Formattext
limit?integer

The maximum number of question-answers to return. The default is '50'.

Formatint32
mode?string

The iteration mode to use, otherwise if not set, then "after" is used.

Value in"after" | "before"
owned_by?array<string>

Filters for question-answers owned by any of the provided users.

Response Body

curl -X GET "https://api.devrev.ai/question-answers.list?applies_to_articles=ARTICLE-12345&applies_to_parts=PROD-12345&created_by=DEVU-12345&cursor=string&limit=0&mode=after&owned_by=DEVU-12345"
{
  "next_cursor": "string",
  "prev_cursor": "string",
  "question_answers": [
    {
      "created_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "created_date": "2023-01-01T12:00:00.000Z",
      "display_id": "string",
      "id": "string",
      "modified_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "modified_date": "2023-01-01T12:00:00.000Z",
      "answer": "string",
      "applies_to_parts": [
        {
          "type": "capability",
          "display_id": "string",
          "id": "string",
          "name": "string",
          "owned_by": [
            {
              "type": "dev_user",
              "display_id": "string",
              "id": "string",
              "display_name": "string",
              "display_picture": {
                "display_id": "string",
                "id": "string",
                "file": {
                  "type": "string",
                  "name": "string",
                  "size": 0
                }
              },
              "email": "string",
              "full_name": "string",
              "state": "active"
            }
          ],
          "sync_metadata": {
            "external_reference": "string",
            "origin_system": "string"
          }
        }
      ],
      "question": "string",
      "sources": [
        {
          "type": "account",
          "display_id": "string",
          "id": "string",
          "display_name": "string"
        }
      ],
      "status": "archived",
      "suggested_answer": "string",
      "suggested_for_deletion": true,
      "topic": "string",
      "verified": true
    }
  ],
  "total": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}