{"openapi":"3.1.0","info":{"title":"Takadar Public API","description":"The Takadar public API. One school, one key, read access to the records that\nschool already owns.\n\n**Authentication.** Send your key as `Authorization: Bearer tk_live_…`, or as\n`X-API-Key`. Keys are minted in the dashboard under Settings → Developers and\nshown once; there is no way to recover one afterwards, only to revoke it and\nmint another.\n\n**Scopes.** A key carries an explicit list of permissions and nothing else — no\nkey is an administrator. A call outside a key's scopes returns `403` with code\n`insufficient_scope`.\n\n**Rate limits.** Per key, per minute, set on the key. Exceeding it returns\n`429` with a `Retry-After` header.\n\n**Pagination.** Every collection returns `{items, total, page, page_size,\npages}` and accepts `page` and `page_size` (200 maximum).\n\n**Syncing.** Every collection accepts `updated_since`. Store the time your last\nsync started, pass it next run, and you fetch only what changed — collections\nare ordered by `updated_at` so a paged sweep is stable.\n\n**Money.** Always an integer in minor units (kobo, cents) plus the ISO 4217\n`currency` of that row. Never a float, and never the school's current currency\napplied retroactively to an old record.\n\n**Webhooks.** Rather than polling, register an endpoint in the dashboard and\nverify the `X-Takadar-Signature` header. `GET /events` documents the catalogue\nand the signature recipe.","version":"1.0.0"},"paths":{"/api/public/v1/me":{"get":{"tags":["public-api"],"summary":"Describe the calling key","operationId":"whoami_api_public_v1_me_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyIdentityOut"}}}}}}},"/api/public/v1/events":{"get":{"tags":["public-api"],"summary":"Webhook events and signing","operationId":"webhook_guide_api_public_v1_events_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookGuideOut"}}}}}}},"/api/public/v1/students":{"get":{"tags":["public-api"],"summary":"List students","operationId":"list_students_api_public_v1_students_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"1-based page number.","title":"Page"},"description":"1-based page number."},{"name":"page_size","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":200,"minimum":1},{"type":"null"}],"description":"Rows per page, 200 maximum.","title":"Page Size"},"description":"Rows per page, 200 maximum."},{"name":"updated_since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta.","title":"Updated Since"},"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by student status.","title":"Status"},"description":"Filter by student status."},{"name":"admission_number","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Admission Number"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_StudentOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/students/{student_id}":{"get":{"tags":["public-api"],"summary":"Fetch one student","operationId":"get_student_api_public_v1_students__student_id__get","parameters":[{"name":"student_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Student Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StudentOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/enrollments":{"get":{"tags":["public-api"],"summary":"List enrollments","operationId":"list_enrollments_api_public_v1_enrollments_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"1-based page number.","title":"Page"},"description":"1-based page number."},{"name":"page_size","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":200,"minimum":1},{"type":"null"}],"description":"Rows per page, 200 maximum.","title":"Page Size"},"description":"Rows per page, 200 maximum."},{"name":"updated_since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta.","title":"Updated Since"},"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta."},{"name":"batch_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Batch Id"}},{"name":"class_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Class Id"}},{"name":"student_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Student Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_EnrollmentOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/staff":{"get":{"tags":["public-api"],"summary":"List staff","operationId":"list_staff_api_public_v1_staff_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"1-based page number.","title":"Page"},"description":"1-based page number."},{"name":"page_size","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":200,"minimum":1},{"type":"null"}],"description":"Rows per page, 200 maximum.","title":"Page Size"},"description":"Rows per page, 200 maximum."},{"name":"updated_since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta.","title":"Updated Since"},"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta."},{"name":"is_active","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_StaffOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/batches":{"get":{"tags":["public-api"],"summary":"List batches","operationId":"list_batches_api_public_v1_batches_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"1-based page number.","title":"Page"},"description":"1-based page number."},{"name":"page_size","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":200,"minimum":1},{"type":"null"}],"description":"Rows per page, 200 maximum.","title":"Page Size"},"description":"Rows per page, 200 maximum."},{"name":"updated_since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta.","title":"Updated Since"},"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_BatchOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/terms":{"get":{"tags":["public-api"],"summary":"List terms and semesters","operationId":"list_terms_api_public_v1_terms_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"1-based page number.","title":"Page"},"description":"1-based page number."},{"name":"page_size","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":200,"minimum":1},{"type":"null"}],"description":"Rows per page, 200 maximum.","title":"Page Size"},"description":"Rows per page, 200 maximum."},{"name":"updated_since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta.","title":"Updated Since"},"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta."},{"name":"batch_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Batch Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_TermOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/classes":{"get":{"tags":["public-api"],"summary":"List classes and programme levels","operationId":"list_classes_api_public_v1_classes_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"1-based page number.","title":"Page"},"description":"1-based page number."},{"name":"page_size","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":200,"minimum":1},{"type":"null"}],"description":"Rows per page, 200 maximum.","title":"Page Size"},"description":"Rows per page, 200 maximum."},{"name":"updated_since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta.","title":"Updated Since"},"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta."},{"name":"programme_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Programme Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_ClassOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/sections":{"get":{"tags":["public-api"],"summary":"List sections","operationId":"list_sections_api_public_v1_sections_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"1-based page number.","title":"Page"},"description":"1-based page number."},{"name":"page_size","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":200,"minimum":1},{"type":"null"}],"description":"Rows per page, 200 maximum.","title":"Page Size"},"description":"Rows per page, 200 maximum."},{"name":"updated_since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta.","title":"Updated Since"},"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta."},{"name":"class_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Class Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_SectionOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/subjects":{"get":{"tags":["public-api"],"summary":"List subjects and courses","operationId":"list_subjects_api_public_v1_subjects_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"1-based page number.","title":"Page"},"description":"1-based page number."},{"name":"page_size","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":200,"minimum":1},{"type":"null"}],"description":"Rows per page, 200 maximum.","title":"Page Size"},"description":"Rows per page, 200 maximum."},{"name":"updated_since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta.","title":"Updated Since"},"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_SubjectOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/invoices":{"get":{"tags":["public-api"],"summary":"List student invoices","operationId":"list_invoices_api_public_v1_invoices_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"1-based page number.","title":"Page"},"description":"1-based page number."},{"name":"page_size","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":200,"minimum":1},{"type":"null"}],"description":"Rows per page, 200 maximum.","title":"Page Size"},"description":"Rows per page, 200 maximum."},{"name":"updated_since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta.","title":"Updated Since"},"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta."},{"name":"student_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Student Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_InvoiceOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/payments":{"get":{"tags":["public-api"],"summary":"List payments","operationId":"list_payments_api_public_v1_payments_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"1-based page number.","title":"Page"},"description":"1-based page number."},{"name":"page_size","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":200,"minimum":1},{"type":"null"}],"description":"Rows per page, 200 maximum.","title":"Page Size"},"description":"Rows per page, 200 maximum."},{"name":"updated_since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta.","title":"Updated Since"},"description":"Only rows changed at or after this instant (ISO 8601). Pass the timestamp of your last successful sync to fetch just the delta."},{"name":"student_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Student Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_PaymentOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ApiKeyIdentityOut":{"properties":{"school_id":{"type":"string","format":"uuid","title":"School Id"},"school_name":{"type":"string","title":"School Name"},"key_name":{"type":"string","title":"Key Name"},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes"},"rate_limit_per_minute":{"type":"integer","title":"Rate Limit Per Minute"},"allow_internal_api":{"type":"boolean","title":"Allow Internal Api"}},"type":"object","required":["school_id","school_name","key_name","scopes","rate_limit_per_minute","allow_internal_api"],"title":"ApiKeyIdentityOut","description":"What `GET /me` tells a caller about the key it just used."},"BatchOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"start_date":{"type":"string","format":"date","title":"Start Date"},"end_date":{"type":"string","format":"date","title":"End Date"},"is_active":{"type":"boolean","title":"Is Active"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","start_date","end_date","is_active","created_at","updated_at"],"title":"BatchOut"},"ClassOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"numeric_name":{"type":"integer","title":"Numeric Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"programme_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Programme Id"},"level":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Level"},"phase":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phase"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","numeric_name","description","programme_id","level","phase","created_at","updated_at"],"title":"ClassOut"},"EnrollmentOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"student_id":{"type":"string","format":"uuid","title":"Student Id"},"batch_id":{"type":"string","format":"uuid","title":"Batch Id"},"class_id":{"type":"string","format":"uuid","title":"Class Id"},"section_id":{"type":"string","format":"uuid","title":"Section Id"},"roll_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Roll Number"},"enrolled_at":{"type":"string","format":"date-time","title":"Enrolled At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","student_id","batch_id","class_id","section_id","roll_number","enrolled_at","created_at","updated_at"],"title":"EnrollmentOut"},"EventTypeOut":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"}},"type":"object","required":["name","description"],"title":"EventTypeOut"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InvoiceOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"student_id":{"type":"string","format":"uuid","title":"Student Id"},"invoice_number":{"type":"string","title":"Invoice Number"},"issued_date":{"type":"string","format":"date","title":"Issued Date"},"due_date":{"type":"string","format":"date","title":"Due Date"},"total_amount_minor":{"type":"integer","title":"Total Amount Minor"},"currency":{"type":"string","title":"Currency"},"status":{"type":"string","title":"Status"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","student_id","invoice_number","issued_date","due_date","total_amount_minor","currency","status","created_at","updated_at"],"title":"InvoiceOut","description":"Money is integer minor units plus the row's own currency, always.\n\n`currency` is the currency of this invoice, not of the school today: a\nschool that switches currency must not retroactively restate old bills."},"ListResponse_BatchOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BatchOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"pages":{"type":"integer","title":"Pages"}},"type":"object","required":["items","total","page","page_size","pages"],"title":"ListResponse[BatchOut]"},"ListResponse_ClassOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ClassOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"pages":{"type":"integer","title":"Pages"}},"type":"object","required":["items","total","page","page_size","pages"],"title":"ListResponse[ClassOut]"},"ListResponse_EnrollmentOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/EnrollmentOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"pages":{"type":"integer","title":"Pages"}},"type":"object","required":["items","total","page","page_size","pages"],"title":"ListResponse[EnrollmentOut]"},"ListResponse_InvoiceOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InvoiceOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"pages":{"type":"integer","title":"Pages"}},"type":"object","required":["items","total","page","page_size","pages"],"title":"ListResponse[InvoiceOut]"},"ListResponse_PaymentOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PaymentOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"pages":{"type":"integer","title":"Pages"}},"type":"object","required":["items","total","page","page_size","pages"],"title":"ListResponse[PaymentOut]"},"ListResponse_SectionOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/SectionOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"pages":{"type":"integer","title":"Pages"}},"type":"object","required":["items","total","page","page_size","pages"],"title":"ListResponse[SectionOut]"},"ListResponse_StaffOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/StaffOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"pages":{"type":"integer","title":"Pages"}},"type":"object","required":["items","total","page","page_size","pages"],"title":"ListResponse[StaffOut]"},"ListResponse_StudentOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/StudentOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"pages":{"type":"integer","title":"Pages"}},"type":"object","required":["items","total","page","page_size","pages"],"title":"ListResponse[StudentOut]"},"ListResponse_SubjectOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/SubjectOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"pages":{"type":"integer","title":"Pages"}},"type":"object","required":["items","total","page","page_size","pages"],"title":"ListResponse[SubjectOut]"},"ListResponse_TermOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/TermOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"pages":{"type":"integer","title":"Pages"}},"type":"object","required":["items","total","page","page_size","pages"],"title":"ListResponse[TermOut]"},"PaymentOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"student_id":{"type":"string","format":"uuid","title":"Student Id"},"amount_minor":{"type":"integer","title":"Amount Minor"},"currency":{"type":"string","title":"Currency"},"payment_method":{"type":"string","title":"Payment Method"},"gateway":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gateway"},"status":{"type":"string","title":"Status"},"paid_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Paid At"},"receipt_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Number"},"transaction_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Reference"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","student_id","amount_minor","currency","payment_method","gateway","status","paid_at","receipt_number","transaction_reference","created_at","updated_at"],"title":"PaymentOut"},"SectionOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"class_id":{"type":"string","format":"uuid","title":"Class Id"},"name":{"type":"string","title":"Name"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","class_id","name","created_at","updated_at"],"title":"SectionOut"},"StaffOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"employee_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Employee Id"},"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"designation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Designation"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"date_of_joining":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date Of Joining"},"is_active":{"type":"boolean","title":"Is Active"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","employee_id","first_name","last_name","designation","email","phone","date_of_joining","is_active","created_at","updated_at"],"title":"StaffOut"},"StudentOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"admission_number":{"type":"string","title":"Admission Number"},"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"date_of_birth":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date Of Birth"},"gender":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gender"},"status":{"type":"string","title":"Status"},"photo_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Photo Url"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","admission_number","first_name","last_name","date_of_birth","gender","status","photo_url","created_at","updated_at"],"title":"StudentOut"},"SubjectOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"is_elective":{"type":"boolean","title":"Is Elective"},"subject_group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject Group"},"credit_units":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credit Units"},"level":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Level"},"academic_unit_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Academic Unit Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","code","is_elective","subject_group","credit_units","level","academic_unit_id","created_at","updated_at"],"title":"SubjectOut","description":"A subject in K-12, a course in higher education — one table, one shape.\n\n`credit_units` is null for K-12 and set for higher education; that is the\nonly difference, and it is the flag credit-weighted GPA keys off."},"TermOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"batch_id":{"type":"string","format":"uuid","title":"Batch Id"},"name":{"type":"string","title":"Name"},"sequence":{"type":"integer","title":"Sequence"},"kind":{"type":"string","title":"Kind"},"start_date":{"type":"string","format":"date","title":"Start Date"},"end_date":{"type":"string","format":"date","title":"End Date"},"is_active":{"type":"boolean","title":"Is Active"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","batch_id","name","sequence","kind","start_date","end_date","is_active","created_at","updated_at"],"title":"TermOut"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WebhookGuideOut":{"properties":{"signature_header":{"type":"string","title":"Signature Header"},"event_header":{"type":"string","title":"Event Header"},"event_id_header":{"type":"string","title":"Event Id Header"},"delivery_header":{"type":"string","title":"Delivery Header"},"signed_payload_format":{"type":"string","title":"Signed Payload Format"},"tolerance_seconds":{"type":"integer","title":"Tolerance Seconds"},"algorithm":{"type":"string","title":"Algorithm"},"events":{"items":{"$ref":"#/components/schemas/EventTypeOut"},"type":"array","title":"Events"}},"type":"object","required":["signature_header","event_header","event_id_header","delivery_header","signed_payload_format","tolerance_seconds","algorithm","events"],"title":"WebhookGuideOut","description":"Everything needed to verify a delivery, served from the API itself."}},"securitySchemes":{"ApiKeyBearer":{"type":"http","scheme":"bearer","description":"Your key, as `Authorization: Bearer tk_live_…`."},"ApiKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key"}}},"security":[{"ApiKeyBearer":[]},{"ApiKeyHeader":[]}]}