Skip to main content
POST
Get note summary for one entity

Authorizations

x-arms-api-key
string
header
required
x-arms-assume-user
string
header
required

Headers

Carrier
string
required

Carrier ID the request is scoped to.

Body

application/json
entity_id
string

Entity ID to summarize.

entity_type
string

Entity type to summarize.

Response

A successful response.

summary
object

One row of summary data for a single entity, returned by GetNoteSummary and BatchGetNoteSummaries. Designed for list-page badges and counters.