Generate a list or label file

POST

https://ssuccessv2.com/app/api/v1/generate/list-labels

Generates the selected school list or label template. Successful generation returns a downloadable PDF/XLSX file with Content-Disposition; service failures are returned as a JSON error envelope.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Request

This endpoint expects an object.

filtersobjectRequired

Selection and filtering payload consumed by ListLabelsService.

layoutmap from strings to anyRequired

Output layout options such as label size

idinteger or nullOptional

template_type_idinteger or nullOptional

academic_year_idintegerOptional

columnslist of maps from strings to anyOptional

htmlstring or nullOptional

Response headers

Content-DispositionstringOptional

Attachment filename

Response

Generated file download

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v1/generate/list-labels \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"filters": {
>	"selectedCard": "students",
>	"selectedEntityIds": [
>	101,
>	102
>	],
>	"isExcel": false
>	},
>	"layout": {
>	"customTitle": "Annual Fund contacts",
>	"showBorder": true
>	},
>	"template_type_id": 1,
>	"academic_year_id": 2026,
>	"columns": []
>	}'