Skip to main content
POST
/
orgs
/
{org_id}
/
nodes
/
search
Search Nodes
curl --request POST \
  --url https://api.example.com/orgs/{org_id}/nodes/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "tags": {},
  "tag_match_mode": "all",
  "directories": [
    "<string>"
  ],
  "recursive_directories": false,
  "created_by": "<string>",
  "min_children": 123,
  "max_children": 123,
  "min_parents": 123,
  "max_parents": 123,
  "min_descendants": 123,
  "max_descendants": 123,
  "min_ancestors": 123,
  "max_ancestors": 123,
  "title_contains": "<string>",
  "limit": 50,
  "offset": 0
}
'
{
  "nodes": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "org_id": "<string>",
      "public_id": "<string>",
      "created_by": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by_email": "<string>",
      "tags": {},
      "directories": [
        "<string>"
      ],
      "num_parents": 123,
      "num_children": 123,
      "num_descendants": 0,
      "num_ancestors": 0
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Headers

authorization
string | null

Path Parameters

org_id
string<uuid>
required

Body

application/json

Request model for unified node search with optional filters.

tags
Tags · object

Tag key-value pairs to filter by

tag_match_mode
enum<string> | null
default:all

'all' requires every tag to match (AND), 'any' requires at least one (OR)

Available options:
all,
any
directories
string[] | null

Directory paths to filter by

recursive_directories
boolean | null
default:false

Include subdirectories when filtering by directory

created_by
string | null

Filter by creator user ID

min_children
integer | null

Minimum number of child nodes

max_children
integer | null

Maximum number of child nodes

min_parents
integer | null

Minimum number of parent nodes

max_parents
integer | null

Maximum number of parent nodes

min_descendants
integer | null

Minimum number of descendant nodes

max_descendants
integer | null

Maximum number of descendant nodes

min_ancestors
integer | null

Minimum number of ancestor nodes

max_ancestors
integer | null

Maximum number of ancestor nodes

title_contains
string | null

Case-insensitive title search

limit
integer | null
default:50

Maximum results to return

offset
integer | null
default:0

Number of results to skip

Response

Successful Response

Response model for paginated node lists.

nodes
NodeResponse · object[]
required

List of nodes

total
integer
required

Total number of nodes

limit
integer
required

Items per page

offset
integer
required

Current offset