Skip to main content
POST
Draft 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

The draft on file was made over these same people: it was reused.

What an ask for the free draft did, and the chart after it.

chart
AccountOrgChartSchema · object
required

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

outcome
enum<string>
required

drafted; reused (the people had not changed, nothing was asked); capped (no free drafts left); failed (try again).

Available options:
drafting,
drafted,
reused,
capped,
failed
changed_person_ids
string<uuid>[]

Each person whose line this draft drew new or moved, most senior first. Empty when it changed nothing, and for a reused draft.

dropped_person_ids
string<uuid>[]

Each person whose drafted line this draft took away: the draft guessed no line for them this time, or one a person had called wrong.