Skip to content
Metakip Docs

Search Pages By Title

GET
/pages/search
curl --request GET \
  --url https://app.metakip.com/api/v1/pages/search \
  --header 'Authorization: Bearer <token>'

Returns accessible, non-deleted pages whose titles match the query. Search uses English full-text matching with a partial-title fallback and returns at most 20 results ordered by relevance.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
string

Text to search for in page titles. Blank or omitted queries return no results.

Responses

Section titled “Responses”

200

Section titled “200”

Accessible pages with matching titles and computed folder paths.

Media typeapplication/json
object
data
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
parentId
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
title
required
string
icon
required
Any of:
string
cover
required
Any of:
object
type
required
string
value
required
Any of:
string
properties
required
Any of:
object
key
additional properties
ownerId
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
permission
required
Any of:
string
Allowed values: view edit admin
createdAt
required
string
updatedAt
required
string
folderPath
required
string
Example
{
  "data": [
    {
      "permission": "view"
    }
  ]
}

403

Section titled “403”

The API token is missing a required scope: pages:read.

Media typeapplication/json

Structured error returned when the request cannot be completed.

object
error
required

Error details for programmatic handling.

object
code
required

Stable error code.

string
message
required

Human-readable explanation.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}