Skip to main content
GET
One page of a shared view, for the signed-in customer

Authorizations

Authorization
string
header
required

A hpt_… customer portal token, as Authorization: Bearer. Stored hashed and looked up by its full SHA-256 hash; shown once at issue. The query string (?token=) is not accepted: a token there ends up in request logs and traces. A browser page trades the token for a portalSession cookie with POST /portal/api/session.

Path Parameters

id
string
required

Query Parameters

limit
integer
default:25
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0

Response

A page of the customer's rows.

view
object
required
columns
object[]
required
rows
object[]
required
count
integer
required
total
integer
required
total_capped
boolean
required
limit
integer
required
offset
integer
required