Listar pedidos de serviço
RegistosGET /service-requests
Returns the service requests submitted to the caller's tenant, newest-first pages of at most 100 items (20 by default) driven by limit and the after cursor. Before each item is returned its quote state is brought up to date, so a quote whose validity has passed shows as expired and a paid quote moves the request forward. Requires the connections:read permission.
Parâmetros
statusReturns only requests in this exact status (submitted, accepted, declined, withdrawn, visit_scheduled, quoted, payment_pending, scheduled or completed); omit it to list requests in every status.
um de
submitted,accepted,declined,withdrawnlimitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
Devolve
200 Service requests of the authenticated utility tenant
Mostrar atributos
dataMostrar atributos filhos
idtenant_idphonefull_nameaddressplus_codelocalitylandmarkservice_typeum de
new_connectioncategoryum de
residential,commercial,industrial,institutional,governmentstatusum de
submitted,accepted,visit_scheduled,quoted,payment_pending,scheduled,completed,declined,withdrawnpricedestimate_min_centsestimate_max_centscurrencydecline_reasonCode from the tenant's configured decline reasons
decline_reason_labelThe tenant's wording of the reason when it was chosen
decline_noteaccount_idAccount the connection was installed on; the requester is linked to it
account_numberNumber of the referenced account, e.g. CTA-000044. Omitted when unknown.
account_holder_nameDisplay name of the customer who holds the referenced account. Omitted when unknown.
customer_idcustomer_nameDisplay name of the referenced customer. Omitted when unknown.
property_idproperty_addressAddress line of the referenced property. Omitted when unknown.
property_holder_nameDisplay name of the customer who holds the referenced property. Omitted when unknown.
connection_idconnection_holder_nameDisplay name of the customer who holds the referenced connection. Omitted when unknown.
connection_statusquote_idThe current quote
site_visit_idThe current site visit
invoice_idInvoice the accepted quote is paid through
payment_idreceipt_numberwork_order_idInstallation work order booked once paid
installation_datequoteMostrar atributos filhos
idtenant_idrequest_idversionstatusum de
issued,accepted,declined,superseded,expired,paid,cancelledautomaticPriced at once from the tariff without staff
site_visit_idtariff_version_idlinesMostrar atributos filhos
idpositionkindum de
connection_fee,material,labour,othercharge_codedescriptionquantitylist_price_centsThe tariff's unit price when the line came from it
unit_price_centstaxabletotal_centsQuantity times unit price
tax_centsadjustment_reason
subtotal_centstax_centstotal_centscurrencyvalid_untilLast day the quote can be accepted
notesissued_byissued_ataccepted_atdeclined_atdecline_noteinvoice_idinvoice_numberpayment_idreceipt_numberpaid_atcreated_atupdated_at
site_visitMostrar atributos filhos
idtenant_idrequest_idstatusum de
scheduled,completed,cancelledvisit_datebooked_byum de
consumer,staffnotesoutcomequote_idcompleted_atcancelled_atcreated_atupdated_at
can_book_visitThe requester may book a site visit from the offered days
decided_bydecided_atcreated_atupdated_at
has_morenext_cursor
Erros 403
Permissões connections:read · Funções: admin, analyst, customer_service, operations, owner, viewer
curl -X GET "$BUSINESS_API/service-requests" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/service-requests", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/service-requests",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/service-requests", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "ser_2DBQqPj0WzZs0v5cORdA4r1imPJ",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"phone": "+258841234567",
"full_name": "Ana Matsinhe",
"address": "Av. Julius Nyerere 1420, Maputo",
"plus_code": "PLU-2026-000142",
"locality": "locality",
"landmark": "landmark",
"service_type": "new_connection",
"category": "residential",
"status": "submitted",
"priced": true,
"estimate_min_cents": 1,
"estimate_max_cents": 1,
"currency": "MZN",
"decline_reason": "decline reason",
"decline_reason_label": "decline reason label",
"decline_note": "decline note",
"account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
"account_number": "ACC-2026-000142",
"account_holder_name": "Ana Matsinhe",
"customer_id": "cus_2UuXtOGTHWKlvkoF5so5Joi3Hck",
"customer_name": "Ana Matsinhe",
"property_id": "prp_2ZbuIh1k2RvWMVPQCJD2yPrsOJ3",
"property_address": "Av. Julius Nyerere 1420, Maputo",
"property_holder_name": "Ana Matsinhe",
"connection_id": "con_2wuJTWy9FOCTPGA3noGbHegbLaU",
"connection_holder_name": "Ana Matsinhe",
"connection_status": "connection status",
"quote_id": "quo_26mh1wUlhIGz1c4BTWQl9M2dDyI",
"site_visit_id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
"invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
"payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
"receipt_number": "REC-2026-000142",
"work_order_id": "wko_2ecrvKOzr4kPhwgtrQAD7gM53yk",
"installation_date": "2026-11-19",
"quote": {
"id": "ser_2cAPViWrBMoJHYSb9GajpwyHJEy",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
"version": 1,
"status": "issued",
"automatic": true,
"site_visit_id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
"tariff_version_id": "tar_2TzCwDDsMdpa2HfkINTSsLvKunb",
"lines": [
{
"id": "ser_2bBeKTRWGj1a0TJoARlcel7MIL7",
"position": 1,
"kind": "connection_fee",
"charge_code": "CHA-2026-000142",
"description": "Leitura confirmada no local.",
"quantity": 1,
"list_price_cents": 125000,
"unit_price_cents": 125000,
"taxable": true,
"total_cents": 125000,
"tax_cents": 1,
"adjustment_reason": "adjustment reason"
}
],
"subtotal_cents": 125000,
"tax_cents": 1,
"total_cents": 125000,
"currency": "MZN",
"valid_until": "2026-11-19T09:30:00Z",
"notes": "Leitura confirmada no local.",
"issued_by": "issued by",
"issued_at": "2026-11-19T09:30:00Z",
"accepted_at": "2026-11-19T09:30:00Z",
"declined_at": "2026-11-19T09:30:00Z",
"decline_note": "decline note",
"invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
"invoice_number": "INV-2026-000142",
"payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
"receipt_number": "REC-2026-000142",
"paid_at": "2026-11-19T09:30:00Z",
"created_at": "2026-11-19T09:30:00Z",
"updated_at": "2026-11-19T09:30:00Z"
},
"site_visit": {
"id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
"status": "scheduled",
"visit_date": "2026-11-19",
"booked_by": "consumer",
"notes": "Leitura confirmada no local.",
"outcome": "outcome",
"quote_id": "quo_26mh1wUlhIGz1c4BTWQl9M2dDyI",
"completed_at": "2026-11-19T09:30:00Z",
"cancelled_at": "2026-11-19T09:30:00Z",
"created_at": "2026-11-19T09:30:00Z",
"updated_at": "2026-11-19T09:30:00Z"
},
"can_book_visit": true,
"decided_by": "decided by",
"decided_at": "2026-11-19T09:30:00Z",
"created_at": "2026-11-19T09:30:00Z",
"updated_at": "2026-11-19T09:30:00Z"
}
],
"has_more": true,
"next_cursor": "next cursor"
}