Authorizations
Cookie-based authentication
Query Parameters
The format of the export
Available options:
xlsx, csv, json Response
Successful operation
The response is of type object[].
export
Export user profiles and their permissions
Export all user profiles and their associated data including permissions. Used primarily by workforce managers to quickly view all profiles.
GET
Export user profiles and their permissions
Previous
Export custom client reportsExport data using custom SQL queries with dynamic parameters. This endpoint allows you to execute
pre-configured SQL queries with customizable parameters that replace placeholders in the query.
## How Parameters Work
1. **SQL Query Placeholders**: Custom exports contain SQL queries with placeholders like `{limit}`, `{offset}`, `{customerId}`
2. **Parameter Resolution**: Parameters are resolved in this order:
- GET query parameters (highest priority)
- Default values from export configuration
- Required parameters will throw an error if missing
3. **Security**: All parameters are safely bound using prepared statements
## Example Custom Export Configuration
```json
{
"label": "Customer Events Report",
"sqlQuery": "SELECT id, type, createdAt FROM event WHERE customerId = {customerId} ORDER BY id DESC LIMIT {limit} OFFSET {offset}",
"parameters": [
{
"key": "customerId",
"label": "Customer ID",
"description": "The customer to export events for",
"defaultValue": null
},
{
"key": "limit",
"label": "Limit",
"description": "Maximum number of records to return",
"defaultValue": "100"
},
{
"key": "offset",
"label": "Offset",
"description": "Number of records to skip",
"defaultValue": "0"
}
]
}
```
## Example Usage
```
GET /api/mind/export/customData?exportId=0&format=json&customerId=12345&limit=50&offset=0
```
This would execute:
```sql
SELECT id, type, createdAt FROM event WHERE customerId = ? ORDER BY id DESC LIMIT ? OFFSET ?
```
With parameters: `[12345, 50, 0]`
Next
Export user profiles and their permissions