Skip to main content
GET
/
api
/
system
/
search
System-wide search
curl --request GET \
  --url https://my.propops.app/api/system/search \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Operation completed successfully",
  "data": [
    {
      "type": "<string>",
      "title": "<string>",
      "subtitle": "<string>",
      "url": "<string>",
      "icon": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://help.propops.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

All API requests must include a valid Bearer token in the Authorization header. Tokens are 64-character SHA-256 session hashes issued by the PropOps authentication system.

Example:

Authorization: Bearer a1b2c3d4e5f6...

Query Parameters

​
q
string
required
Minimum string length: 2
Example:

"boiler"

​
type
enum<string>
default:all
Available options:
users,
branches,
contractors,
all
​
limit
integer
default:50

Maximum number of records to return (default 50, max 200).

Required range: 1 <= x <= 200

Response

Search results

​
success
boolean
Example:

true

​
message
string
Example:

"Operation completed successfully"

​
data
object[]