Skip to content

Get Team Bootstrap

GET
/sales-coach/team/bootstrap

Everything a Team HQ screen needs in ONE call.

The boards, the sets, the config and the first page of data together. Built for a display that would otherwise make five round trips before it can render anything, and it is the right call for a dashboard rebuilding this rather than fetching each piece.

Authorizations

Parameters

Query Parameters

period

Window to score over. today is the app’s default; the values a given org accepts come back in visible_periods from GET /sales-coach/team/config, because the set is configurable.

string
default: today

Window to score over. today is the app’s default; the values a given org accepts come back in visible_periods from GET /sales-coach/team/config, because the set is configurable.

lb
Any of:
string

Leaderboard to open on.

set
Any of:
string

Rotation to open on. The wire name is set, matching the app’s ?set= query parameter; set is a Python builtin, so the handler parameter is set_id and the alias keeps the wire name identical to the app’s.

role
Any of:
string

Legacy fallback when neither lb nor set is given.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a config, a bootstrap or a data response.

Open because the leaderboard and set DATA responses carry one key per KPI and the KPI catalogue is org-configurable: a closed model would drop a customer’s own metric, and a leaderboard missing a column reads as a rep having scored nothing.

object
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
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

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