For the complete documentation index, see llms.txt. This page is also available as Markdown.

Search content in an organization

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
Query parameters
querystring · max: 512Required
pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses
200

OK

application/json
countnumberOptional

Total count of objects in the list

get/orgs/{organizationId}/search
GET /v1/orgs/{organizationId}/search?query=text HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "type": "space",
      "id": "text",
      "title": "text",
      "score": 1,
      "pages": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "path": "text",
          "score": 1,
          "rank": 1,
          "resultType": "page",
          "sections": [
            {
              "id": "text",
              "title": "text",
              "path": "text",
              "score": 1,
              "resultType": "page",
              "body": "text",
              "urls": {
                "app": "https://example.com"
              }
            }
          ],
          "ancestors": [
            {
              "title": "text"
            }
          ],
          "urls": {
            "app": "https://example.com"
          }
        }
      ]
    }
  ]
}

Last updated

Was this helpful?

Powered by GitBook