Skip to main content
GET
Get an account's org chart

Authorizations

X-API-Key
string
header
required

Path Parameters

account_key
string
required

The account's key: its domain (acme.com), or its LinkedIn page (li-co:acme).

Required string length: 1 - 320
Pattern: ^(?:[^/.][^/]*|\.[^/.][^/]*|\.\.[^/]+)$

Query Parameters

levels
integer | null

Draw only this many levels of each tree, while 400 cards last, and send only the people drawn and the ones the page names. Left out, the whole chart.

Required range: 1 <= x <= 12
expand
string<uuid>[]

With levels: people whose reports are drawn whatever their level.

Maximum array length: 500
focus
string<uuid> | null

With levels: a person to draw the way down to.

loose
integer
default:30

With levels: how many people with no line either way to draw.

Required range: 0 <= x <= 5000

Response

Successful Response

An account's org chart: every person with their line, hidden people last.

budget_holder_candidates
AccountBudgetCandidateReadSchema · object[]
required

Up to three people the draft thinks may hold the budget; a rep decides.

draft_current
boolean
required

Whether the draft was made over the people shown now.

drafted_at
string<date-time> | null
required

When the free draft was made, if ever.

drafts_left
integer
required

Free drafts left in the rolling 24 hours.

drafts_reset_at
string<date-time> | null
required

When the next free draft frees up, once none is left.

lost
AccountChartLossReadSchema · object[]
required

Each role or line a rep set whose person is no longer at the account, newest first. What the rep set is kept, and comes back if the person does.

people
AccountChartPersonReadSchema · object[]
required
draft_guesses
integer
default:0

Of the people a draft reads, those with no confirmed line: the ones it guesses a line for.

draft_reads
integer
default:0

People a draft reads: the most senior shown, up to 150. Past that, the more junior are left out.

likely_lines
integer
default:0

Lines drawn from the draft now, each Likely until a person confirms it: GET /accounts/{account_key}/org-chart/drafted-lines/ lists them.

loops
AccountChartLoopReadSchema · object[]

Each loop of reporting lines no person has decided (the tables', the researcher's, or lines people set that a merge brought together): the chart leaves one of its lines out. A person picks one by setting a person's manager (PATCH /accounts/{account_key}/people/{person_id}/); in a loop of lines people set, the others are handed back first (manager_choice null), as a line to them would loop.

manager_offers
AccountManagerColumnOfferReadSchema · object[]

Each people table here with a column labelled like a manager (Manager, Reports to) that is not its manager column yet. Nothing is drawn from it until a person picks it: PATCH /accounts/sources/{table_id}/ with manager_column_id.

top_person_id
string<uuid> | null

The account's top person when no line says so yet: the head of the biggest tree, with no line of their own (none drawn, none left out for a loop) and no other person at the top of the chart as senior. The page reads them as Top of the account.

tree_heads
string<uuid>[]

Each person heading a tree (no manager drawn, someone under them), the most people under them first: the order the chart lists its trees in. Hidden people are never counted. With levels, only the heads this answer sends.

window
AccountChartWindowReadSchema · object | null

With levels: the part of the chart sent. None: all of it.