Sign in

ebd602e4aea4

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-1091438458.0 KB
Documents

Read documents by facets

Read the documents including metadata (does not include enhanced metadata via /documentmetadata) macthing the given facet conditions.

post/rest/api/v1/getdocumentsbyfacets

Query parameters

localestring

The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Request body

datasourcesFilterstring[]

Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing.

cursorstring

Pagination cursor. A previously received opaque token representing the position in the overall results at which to start.

Example request

{
  "filterSets": [
    {
      "filters": [
        {
          "fieldName": "type",
          "values": [
            {
              "value": "Spreadsheet",
              "relationType": "EQUALS"
            },
            {
              "value": "Presentation",
              "relationType": "EQUALS"
            }
          ]
        }
      ]
    }
  ]
}

Response

OK

hasMoreResultsboolean

Whether more results are available. Use cursor to retrieve them.

cursorstring

Cursor that indicates the start of the next page of results. To be passed in "more" requests for this query.

Example response

{
  "documents": [
    {
      "metadata": {
        "container": "container",
        "parentId": "JIRA_EN-1337",
        "createTime": "2000-01-23T04:56:07.000Z",
        "datasource": "datasource",
        "author": {
          "name": "name"
        },
        "documentId": "documentId",
        "updateTime": "2000-01-23T04:56:07.000Z",
        "mimeType": "mimeType",
        "objectType": "Feature Request",
        "components": [
          "Backend",
          "Networking"
        ],
        "status": "Done",
        "customData": {
          "someCustomField": {
            "stringValue": "someCustomValue"
          }
        }
      }
    }
  ]
}