Documents

Search all documents

This methods allows you to search your teams documents with keywords. Note that search results will be restricted to those accessible by the current access token.

post/documents.search

Request body

offsetnumber

limitnumber

querystring

userIdstring uuid

Any documents that have not been edited by the user identifier will be filtered out

collectionIdstring uuid

A collection to search within

documentIdstring uuid

A document to search within

statusFilter'draft' | 'archived' | 'published'

Any documents that are not in the specified status will be filtered out

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

Any documents that have not been updated within the specified period will be filtered out

Example request

{
  "limit": 25,
  "query": "hiring",
  "statusFilter": "published",
  "dateFilter": "month"
}

Response

Example response

{
  "data": [
    {
      "context": "At Acme Inc our hiring practices are inclusive",
      "ranking": 1.1844109,
      "document": {
        "title": "🎉 Welcome to Acme Inc",
        "emoji": "🎉",
        "text": "…",
        "urlId": "hDYep1TPAM",
        "collaborators": [
          {
            "name": "Jane Doe"
          }
        ],
        "createdBy": {
          "name": "Jane Doe"
        },
        "updatedBy": {
          "name": "Jane Doe"
        }
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

Changed in 2 of the 6 revisions of this API.7

Oct 18, 2024fdf2ec9c9df41See the full diff
- ○
  added the non-success response with the status 429
  response-non-success-status-added
Jul 6, 20247b33b538cd7d6See the full diff
- ○
  added the optional property data to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property data to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 403 status
  response-optional-property-added

Full history