Skip to content

Get Trial Overview List

GET
/accounts/trial-overview/list

The records behind one headline number.

Built from the same predicates as the aggregate, so the list and the count cannot drift. When the source table is unpopulated it answers data_available=false with an empty list - again, not a misleading zero.

Authorizations

Parameters

Query Parameters

metric

Which headline number to drill into.

string
""

Which headline number to drill into.

view

Companies or contacts.

string
default: companies /^(companies|contacts)$/

Companies or contacts.

status

Active or expired trials.

string
default: active /^(active|expired)$/

Active or expired trials.

segment

Enrichment segment, when view=contacts.

string
default: all

Enrichment segment, when view=contacts.

limit
integer
default: 100 >= 1 <= 500

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

Most of these handlers return a bare list[...]; a few return a named envelope ({"team_members": [...], "total": n}). Both are reachable as items, and a named envelope KEEPS its own key as well so a caller already reading the app’s shape is not broken by the wrapper.

object
items
Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string