DEdefaulr
Documents

Search document titles

Changed on

This method allows you to search document titles with keywords. Unlike documents.search, this only searches titles and returns faster results.

post/documents.search_titles

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/documents.search_titles
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

offsetnumber
limitnumber
querystring required

Search query to match against document titles

collectionIdstring uuid

Filter to a specific collection. Deprecated – prefer the filters parameter.

userIdstring uuid

Filter results based on user. Deprecated – prefer the filters parameter.

documentIdstring uuid

Filter results based on content within a document and its children. Deprecated – prefer the filters parameter.

statusFilterstring[]

Document statuses to include in results. Deprecated – prefer the filters parameter.

dateFilter'day' | 'week' | 'month' | 'year'

Any documents that have not been updated within the specified period will be filtered out. Deprecated – prefer the filters parameter with a date field and an ISO 8601 duration value.

shareIdstring

Filter results for the collection or document referenced by the shareId

sort'relevance' | 'createdAt' | 'updatedAt' | 'title'

Specifies the attributes by which search results will be sorted

direction'ASC' | 'DESC'

Specifies the sort order with respect to sort field

Example request

{
  "limit": 25
}

Response

OK

Example response

{
  "data": [
    {
      "title": "Welcome to Acme Inc",
      "icon": "🎉",
      "text": "…",
      "urlId": "hDYep1TPAM",
      "createdBy": {
        "name": "Jane Doe"
      },
      "updatedBy": {
        "name": "Jane Doe"
      },
      "deletedBy": {
        "name": "Jane Doe"
      }
    }
  ],
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

  • 5ddf01ffba84Revision changes
    • info

      added the optional property // to the response with the status

    • info

      response property data/items/url deprecated

  • 73984ccdae0fRevision changes
    • info

      added the new createdById enum value to the request property ////