{"openapi":"3.1.0","info":{"title":"GET /api/v1/people/import/template","version":"1.0.0","description":"Roster import template"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/people/import/template":{"get":{"tags":["people"],"summary":"Roster import template","description":"A CSV with the columns the roster import understands.","operationId":"people_import_template","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_TemplateResponse_"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"people_import_template_api_v1_people_import_template_get"}}},"components":{"schemas":{"SuccessEnvelope_TemplateResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/TemplateResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[TemplateResponse]"},"TemplateResponse":{"properties":{"template_name":{"type":"string","title":"Template Name","description":"Template identifier."},"csv_content_stringified":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Csv Content Stringified","description":"CSV content as string."},"csv_content_object":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Csv Content Object","description":"CSV parsed as JSON array."},"csv_content_base64":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Csv Content Base64","description":"Base64-encoded CSV for direct download."},"xls_content_base64":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Xls Content Base64","description":"Base64-encoded XLS/XLSX for direct download."},"message":{"type":"string","title":"Message","description":"User-facing message (set when template generation is incomplete).","default":""}},"type":"object","required":["template_name"],"title":"TemplateResponse","description":"Response schema for an upload template.\n\nProvides the template in multiple formats for flexibility.\nCSV-based templates populate csv_* fields; XLS-based templates populate xls_content_base64.","example":{"csv_content_base64":"Y3VzdG9tZXJfZW1haWwsZHVlX2RhdGUuLi4=","csv_content_object":[{"customer_email":"example@customer.com","due_date":"2024-02-15","line_item_amount":"10000","line_item_description":"Service fee"}],"csv_content_stringified":"customer_email,due_date,line_item_description,line_item_amount\n","message":"","template_name":"invoices"},"examples":[{"csv_content_base64":"Y3VzdG9tZXJfZW1haWwsZHVlX2RhdGUuLi4=","csv_content_object":[{"customer_email":"example@customer.com","due_date":"2024-02-15","line_item_amount":"10000","line_item_description":"Service fee"}],"csv_content_stringified":"customer_email,due_date,line_item_description,line_item_amount\n","message":"","template_name":"invoices"}]},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}