Search spotlight index

Search spotlight index

When to use this: Search cards, transactions, support docs, and quick actions.

Required scope: spotlight.read.

POST /user/v1/spotlight/search

Search spotlight index

cURL

curl --request POST \
  --url https://api.machines.cash/user/v1/spotlight/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "ok": true,
  "data": {},
  "summary": "success"
}

Authorizations

Authorization · string · header · required

Bearer session token for User API operations. Legacy UserSessionBearer naming remains supported.

Body

application/json

The body is of type object.

Response

200

application/json

Success

ok · boolean

data · object

summary · string

errors · object[]

Show child attributes

next · string