Search platform

GET https://app.speybooks.com/api/v1/admin/search

Omni-search across users, organisations, and invoices. Accepts a q query parameter (minimum 1 character) and runs three parallel ILIKE searches, returning up to 5 results per entity type.

Search Fields

Users — email, full_name
Organisations — name, slug, UUID
Invoices — invoice_number (includes contact name and formatted total)

Results are typed with type, id, label, and sublabel for uniform rendering in the admin UI.

Response

200 Cross-entity search results (up to 5 per entity type).

Show response fields

invoices array<object>

organisations array<object>

Show child attributes

id string

label string

sublabel string

type string

users array<object>

Show child attributes

id integer

isActive boolean

label string

sublabel string

type string

Request GET /v1/admin/search curl

curl "https://api.speybooks.com/v1/admin/search?q=acme" \
  -H "Authorization: Bearer <admin-token>"

Response 200

{
  "success": true,
  "data": {
    "users": [
      {
        "type": "user",
        "id": 1,
        "label": "jane@acme.com",
        "sublabel": "Jane Doe",
        "isActive": true
      }
    ],
    "organisations": [
      {
        "type": "organisation",
        "id": "uuid",
        "label": "Acme Ltd",
        "sublabel": "sole_trader - active"
      }
    ],
    "invoices": []
  }
}