Skip to content

Export Lifecycle Accounts

POST
/lifecycle-accounts/export

Download the lifecycle Companies grid as CSV: the same rows, order and visible columns the grid shows.

Needs data:export:bulk (Owner and Admin have it) and an explicit companies:run grant. A key whose company scope is “none” is refused 403. The export is audited and alerts the admins.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

The lifecycle Companies grid’s view to export: columns, stage, filters, search and sort.

object
agFilterModel
Any of:
object
key
additional properties
any
agSortModel
Any of:
Array<object>
object
key
additional properties
any
canonical_trial_cohort
boolean
columns
required
Array<object>
>= 1 items <= 200 items

One displayed grid column: the row field and the header the user sees.

object
field
required

Row field, e.g. name or mrr_cents.

string
>= 1 characters <= 64 characters
header
required

Column header as shown in the grid.

string
<= 200 characters
in_pipeline
boolean
lifecycle_id
Any of:
string
pipeline_id
Any of:
string format: uuid
search
Any of:
string
<= 200 characters
segmentFilter
Any of:
object
key
additional properties
any
status
Any of:
string
tz
Any of:
string
<= 64 characters

Responses

200

The lifecycle Companies grid as a CSV file

string format: binary

422

Validation Error

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