Skip to content
ShareOutShareOut Docs

Palette search index

GET
/v1/home/search-index
curl --request GET \
  --url https://shareout.site/v1/home/search-index \
  --header 'Authorization: Bearer <token>'

Compact index of everything the signed-in user can find by name in the scope (pages, folders, people), ranked locally by the Cmd+K palette. Same visibility as /v1/search; a non-member of workspace gets empty lists. Rows are positional arrays. Revalidate with If-None-Match for a 304. Server-Timing carries idx_build and idx_etag.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
workspace
string

Workspace id; omit for everything the user can see.

Header Parameters

Section titled “Header Parameters”
If-None-Match
string

ETag from a previous response.

Responses

Section titled “Responses”

200

Section titled “200”

The index

Media typeapplication/json
object
v

Format version (1).

integer
truncated

More than 3,000 pages; older ones are left to deep search.

boolean
artifacts

[id, slug, name, type (‘’ = html), folderId, tags (newline-joined), updatedSec, description (80 chars), flags (1 private, 2 thumbnail), ownerIdx, wsIdx]

Array<Array>
folders

[id, name, parentId (‘’ = top level), pageCount]

Array<Array>
people

[userId, name, email, picture, role]

Array<Array<string>>
owners

[name, picture]

Array<Array<string>>
workspaces

[id, name] when searching across workspaces

Array<Array<string>>
recent

Ids of pages the user opened last, newest first.

Array<string>
Examplegenerated
{
  "v": 1,
  "truncated": true,
  "artifacts": [
    [
      "example"
    ]
  ],
  "folders": [
    [
      "example"
    ]
  ],
  "people": [
    [
      "example"
    ]
  ],
  "owners": [
    [
      "example"
    ]
  ],
  "workspaces": [
    [
      "example"
    ]
  ],
  "recent": [
    "example"
  ]
}

Headers

Section titled “Headers”
ETag
string

Weak ETag of this user’s index for this scope.

304

Section titled “304”

Unchanged since the ETag in If-None-Match.

401

Section titled “401”

Authentication required

Media typeapplication/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string
reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string
hint

What to do next, in plain words.

string
suggestion
string
param

The request field at fault.

string
docs

Doc page for this error.

string
redirect_url
string
support

Present on 5xx — how to reach a human.

object
how
string
include
Array<string>
Example
{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}