Skip to content

Requests and responses

A request with a body sends it as JSON, with Content-Type: application/json. A body sent as anything else is refused with 415.

A response is flat JSON. A record is its own fields, with an object field naming what it is, and there is no envelope to unwrap:

Terminal window
curl https://api.summerbase.com/v1/customers/backend:acct_4821 \
-X PATCH \
-H "Authorization: Bearer $SUMMERBASE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"properties": {"name": "Northwind Labs", "seats": 25}}'
{
"id": "0199a7c2-4e1b-7f38-b9d2-5a6c8e0f1d73",
"object": "customer",
"name": "Northwind Labs",
"status": "paying",
"mrr": "1250.00",
"arr": "15000.00"
}

A field with nothing in it is null. A field that holds another object is left out unless the request asks for it; see Expanding responses.