Search

Base URL: $CONSUMER_API

The object

typestring · required

one of customer, account, property, meter, connection, invoice, payment, ticket, work_order, incident, reading_route, organization, …

idstring · required
titlestring · required

What a person recognises, such as a name, invoice number or serial.

subtitlestring · required

One line of context.

statusstring · required
Endpoints
The object
{
  "type": "customer",
  "id": "sea_2IoPVOcVNUC7fuGnj6ErdMyrjuU",
  "title": "Fuga na Rua 3",
  "subtitle": "subtitle",
  "status": "active"
}

Search the authenticated consumer's own resources

Logs

GET /search

Searches only the accounts the consumer holds a membership on and the resources reachable through those memberships, plus tickets the consumer opened. Lookups run concurrently with a per-request timeout. Sources the caller's scopes exclude are omitted; a source that fails for any other reason is omitted and partial becomes true.

Parameters

qstring · query · required

Search text, trimmed before use.

typesstring · query · optional

Comma-separated subset of [account, connection, invoice, payment, ticket]. Defaults to all of them; an unknown type is rejected.

limitinteger · query · optional

Maximum results per type (default 5, larger values are clamped to 20).

Returns

200 Matching resources, grouped by type in a stable order

Show attributes
dataarray of SearchResult · required
Show child attributes
typestring · required

one of customer, account, property, meter, connection, invoice, payment, ticket, work_order, incident, reading_route, organization, …

idstring · required
titlestring · required

What a person recognises, such as a name, invoice number or serial.

subtitlestring · required

One line of context.

statusstring · required
querystring · required

The trimmed search text.

partialboolean · required

True when at least one source failed and its results are missing.

Errors 400 · 401

curl -X GET "$CONSUMER_API/search" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "data": [
    {
      "type": "customer",
      "id": "sea_2IoPVOcVNUC7fuGnj6ErdMyrjuU",
      "title": "Fuga na Rua 3",
      "subtitle": "subtitle",
      "status": "active"
    }
  ],
  "query": "query",
  "partial": true
}