Pesquisar
RegistosGET /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.
Parâmetros
qSearch text, trimmed before use.
typesComma-separated subset of [account, connection, invoice, payment, ticket]. Defaults to all of them; an unknown type is rejected.
limitMaximum results per type (default 5, larger values are clamped to 20).
Devolve
200 Matching resources, grouped by type in a stable order
Mostrar atributos
dataMostrar atributos filhos
typeum de
customer,account,property,meter,connection,invoice,payment,ticket,work_order,incident,reading_route,organization, …idtitleWhat a person recognises, such as a name, invoice number or serial.
subtitleOne line of context.
status
queryThe trimmed search text.
partialTrue when at least one source failed and its results are missing.
curl -X GET "$CONSUMER_API/search" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$CONSUMER_API/search", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$CONSUMER_API/search",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$CONSUMER_API/search", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"type": "customer",
"id": "sea_2IoPVOcVNUC7fuGnj6ErdMyrjuU",
"title": "Fuga na Rua 3",
"subtitle": "subtitle",
"status": "active"
}
],
"query": "query",
"partial": true
}