Search pages

GET 
/wiki/search/pages

History

Version	Changes
v6.2.16	Added in: v6.2.16

Search pages.

Request

Query Parameters

teamID stringrequired

The team ID

requestUserID string

User ID, this parameter can only be passed when calling as an Oauth bot. It is used to perform operations as the specified user

limit integer

Possible values: <= 100

Default value: 50

The number returned by this request.The default value is 50, exceeding 100 will be truncated to 100

cursor string

The starting location of this request

keyword stringrequired

Possible values: <= 100 characters

The search keyword

spaceIDs string

The space ID list split by commas. An empty string searches all spaces.

includeArchived boolean

Default false, true: Search include archived pages, false: Search exclude archived pages.

Responses

200

Request is successful.

application/json

Schema

Schema

data

object

hasNext boolean

Whether has more result

nextCursor string

The start of next page

total integer

The total number of matched pages

pages

object[]

Array [

fields

object

id string

The page ID

title string

The page title

highlightFields

object

title string[]

Matched title

content string[]

Matched content

]

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

errorData object

Error meta data for this request.

Example (from schema)

{
  "data": {
    "hasNext": true,
    "nextCursor": "string",
    "total": 0,
    "pages": [
      {
        "fields": {
          "id": "string",
          "title": "string"
        },
        "highlightFields": {
          "title": [
            "string"
          ],
          "content": [
            "string"
          ]
        }
      }
    ]
  },
  "result": "string",
  "errorCode": "string",
  "errorMsg": "string",
  "errorData": {}
}

401

Returned if the authentication credentials are incorrect or missing.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Unauthorized",
  "errorMsg": "Access token is invalid"
}

403

Returns if the scope check fails.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Forbidden",
  "errorMsg": "Scope is invalid"
}

404

Returned if the resource object was not found.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "NotFound",
  "errorMsg": "Not Found"
}

500

Internal Server Error.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Internal Server Error",
  "errorMsg": "Internal Server Error"
}

Loading...