> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.schoolset.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.schoolset.io/_mcp/server. # Generate a list or label file POST https://ssuccessv2.com/app/api/v1/generate/list-labels Content-Type: application/json 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. Reference: https://docs.schoolset.io/api-reference/school-set-api/lists-and-labels/generate-list-labels ## Authentication - `Authorization` header (bearer token, required) — The signed-in SchoolSet user token sent by the frontend. ## Request ### Body (application/json) This endpoint expects an object. - `filters` (ApiV1GenerateListLabelsPostRequestBodyContentApplicationJsonSchemaFilters, required) — Selection and filtering payload consumed by ListLabelsService. - `layout` (map from string to any, required) — Output layout options such as label size - `id` (integer, optional, nullable) - `template_type_id` (integer, optional, nullable) - `academic_year_id` (integer, optional) - `columns` (list of map from string to any, optional) - `html` (string, optional, nullable) ## Response ### 200 Generated file download - File download. ## Errors ### 401 Unauthorized Error Authentication required - `status` (string, required) - `message` (string, required) - `data` (any, optional, nullable) ### 403 Forbidden Error Permission failure while resolving selected entities or tags - `status` (string, required) - `message` (string, required) - `data` (any, optional, nullable) ### 422 Unprocessable Entity Error List or label generation failed - `status` (string, required) - `message` (string, required) - `data` (any, optional, nullable) ## Types ### ApiV1GenerateListLabelsPostRequestBodyContentApplicationJsonSchemaFilters Selection and filtering payload consumed by ListLabelsService. - `selectedCard` (string, optional) - `selectedEntityIds` (list of integer, optional) - `isExcel` (boolean, optional) ## Examples **Request** ```json { "filters": { "selectedCard": "students", "selectedEntityIds": [ 101, 102 ], "isExcel": false }, "layout": { "customTitle": "Annual Fund contacts", "showBorder": true }, "template_type_id": 1, "academic_year_id": 2026, "columns": [] } ``` **SDK Code** ```python import requests url = "https://ssuccessv2.com/app/api/v1/generate/list-labels" payload = { "filters": { "selectedCard": "students", "selectedEntityIds": [101, 102], "isExcel": False }, "layout": { "customTitle": "Annual Fund contacts", "showBorder": True }, "template_type_id": 1, "academic_year_id": 2026, "columns": [] } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://ssuccessv2.com/app/api/v1/generate/list-labels'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"filters":{"selectedCard":"students","selectedEntityIds":[101,102],"isExcel":false},"layout":{"customTitle":"Annual Fund contacts","showBorder":true},"template_type_id":1,"academic_year_id":2026,"columns":[]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://ssuccessv2.com/app/api/v1/generate/list-labels" payload := strings.NewReader("{\n \"filters\": {\n \"selectedCard\": \"students\",\n \"selectedEntityIds\": [\n 101,\n 102\n ],\n \"isExcel\": false\n },\n \"layout\": {\n \"customTitle\": \"Annual Fund contacts\",\n \"showBorder\": true\n },\n \"template_type_id\": 1,\n \"academic_year_id\": 2026,\n \"columns\": []\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://ssuccessv2.com/app/api/v1/generate/list-labels") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"filters\": {\n \"selectedCard\": \"students\",\n \"selectedEntityIds\": [\n 101,\n 102\n ],\n \"isExcel\": false\n },\n \"layout\": {\n \"customTitle\": \"Annual Fund contacts\",\n \"showBorder\": true\n },\n \"template_type_id\": 1,\n \"academic_year_id\": 2026,\n \"columns\": []\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://ssuccessv2.com/app/api/v1/generate/list-labels") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"filters\": {\n \"selectedCard\": \"students\",\n \"selectedEntityIds\": [\n 101,\n 102\n ],\n \"isExcel\": false\n },\n \"layout\": {\n \"customTitle\": \"Annual Fund contacts\",\n \"showBorder\": true\n },\n \"template_type_id\": 1,\n \"academic_year_id\": 2026,\n \"columns\": []\n}") .asString(); ``` ```php request('POST', 'https://ssuccessv2.com/app/api/v1/generate/list-labels', [ 'body' => '{ "filters": { "selectedCard": "students", "selectedEntityIds": [ 101, 102 ], "isExcel": false }, "layout": { "customTitle": "Annual Fund contacts", "showBorder": true }, "template_type_id": 1, "academic_year_id": 2026, "columns": [] }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://ssuccessv2.com/app/api/v1/generate/list-labels"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"filters\": {\n \"selectedCard\": \"students\",\n \"selectedEntityIds\": [\n 101,\n 102\n ],\n \"isExcel\": false\n },\n \"layout\": {\n \"customTitle\": \"Annual Fund contacts\",\n \"showBorder\": true\n },\n \"template_type_id\": 1,\n \"academic_year_id\": 2026,\n \"columns\": []\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "filters": [ "selectedCard": "students", "selectedEntityIds": [101, 102], "isExcel": false ], "layout": [ "customTitle": "Annual Fund contacts", "showBorder": true ], "template_type_id": 1, "academic_year_id": 2026, "columns": [] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/generate/list-labels")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```