Skip to content

Export Lifecycle Contacts

POST
/lifecycle-contacts/export

Download the stage Contacts grid as CSV: the same rows, order and visible columns the grid shows.

Locked contacts export masked, as on screen. Needs data:export:bulk (Owner and Admin have it) and an explicit contacts:run grant; a key with no contact access is refused. The export is audited and alerts the admins.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

The stage Contacts 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
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. email or company_name.

string
>= 1 characters <= 64 characters
header
required

Column header as shown in the grid.

string
<= 200 characters
company_status
Any of:
string
lifecycle_id
required

Lifecycle stage the grid is scoped to.

string
search
Any of:
string
<= 200 characters
tz
Any of:
string
<= 64 characters

Responses

200

The stage Contacts 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