Export Contact Assets

get

https://api.scalepad.com/lifecycle-manager/v1/assets/contacts/export

Export contacts as a spreadsheet, honoring the supplied search, filters, sort, and selected columns. Exports every matching row, so the page_size and cursor parameters are ignored. The requested xlsx format is downgraded to csv when the result set is too large for a spreadsheet; the response content type and file name reflect the format that was written.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

format

string

enum

Spreadsheet file format. Defaults to xlsx.

Allowed:

columns

array of strings

Optional public column keys to include in the export. Omit to export every available column.

columns

string

Free-text search applied across the console's searchable fields.

client_id

string

Optional Core API client ID used to limit results to one client. Omit to search across accessible clients.

filter

object

Generic console filters keyed by public field name. Supported keys depend on console availability for the requested account or client.

filter_operator

object

Optional operator per filter key. Supported operators are published by each console filter metadata endpoint.

filter_selection

object

Optional multi-select matching mode per filter key. Supported values are published by each console filter metadata endpoint.

page_size

int32

Number of records to return in a single page. Defaults to 50.

cursor

string

Cursor of the page to return. Omit for the first page, then pass the next_cursor value from the previous response.

sort

string

^[+-]?[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*(,[+-]?[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*)*$

One or more sortable fields, separated by commas. Prefix with + to sort ascending or - to sort descending.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

text/csv

application/json

200OK

400Bad Request

403Forbidden

404Not Found