GET/spaces/api/v1/search.json
searches pages' title and content for text and return results
Query Params
- Name
q
- Type
- string
- required
- Description
The search query.
- Name
offset
- Type
- integer
- Description
- Name
limit
- Type
- integer
- Description
- Name
deleted
- Type
- boolean
- Description
Specify whether or not to include deleted pages in the search.
- Default
false
- Name
spaceid
- Type
- array[integer]
- Description
An array of spaceIDs to search within.
- Default
all space ids user has access to
- Format
- Comma separated values
- Name
fields
- Type
- array[string]
- Description
Fields to search within.
- Default
title content
- Format
- Comma separated values
- Allowed values
title
content
tags
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
SearchResponse is a wrapper for search results.
- Code
- 500
- Type
- object
- Schema
- Description
- 500 Internal Server Error
200 OK
SearchResponse
{
"included": {
"spaces": {
"additionalProp": {
"LinkedCategory": {
"category": {
"id": 0,
"meta": {},
"type": "string"
}
},
"banner": "string",
"bannerX": 0,
"bannerY": 0,
"code": "string",
"collaborators": [
{
"id": 0,
"meta": {},
"type": "string"
}
],
"collaboratorsCount": 0,
"createdAt": "2024-09-06T11:47:28.789Z",
"createdBy": {
"id": 0,
"meta": {},
"type": "string"
},
"deletedAt": "2024-09-06T11:47:28.789Z",
"deletedBy": {
"id": 0,
"meta": {},
"type": "string"
},
"homepage": {
"id": 0,
"meta": {},
"type": "string"
},
"icon": "string",
"id": 0,
"projectId": 0,
"purpose": "string",
"spaceColor": "string",
"state": "string",
"title": "string",
"updatedAt": "2024-09-06T11:47:28.789Z",
"updatedBy": {
"id": 0,
"meta": {},
"type": "string"
}
}
}
},
"results": [
{
"matched": {},
"pageId": 0,
"slug": "string",
"space": {
"id": 0,
"type": "string"
},
"tags": [
{
"color": "string",
"name": "string",
"tagId": 0
}
],
"title": "string"
}
],
"totalResults": 0
}