> ## Documentation Index > Fetch the complete documentation index at: https://docs.classquill.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Student > Create a student account (name, subjects, phone, address, placement) and optionally a linked parent. `email` is optional (omit → no-email placeholder account, invite later); when a real email is present and `send_invite` (default true) is set, emails a set-password link. Cross-org placement targets return 404. ## OpenAPI ````yaml /openapi.json post /v1/students openapi: 3.1.0 info: title: ClassQuill Public API description: >- REST API for ClassQuill tutoring organisations. Pipe your sessions, invoices, payments, tutor earnings, students, and more into your own tools. Most endpoints are reads; a focused set of writes (each gated by a *:write scope) create or update data, including creating student/tutor/parent accounts. Authenticate every request with an org API key: Authorization: Token token=ei_live_... Mint keys in the ClassQuill app under Settings → Developers. version: 1.0.0 servers: [] security: - ApiKeyAuth: [] tags: - name: General - name: Sessions - name: Tutors - name: Students & Parents - name: Billing - name: Curriculum - name: Coursework - name: Operations - name: Pricing - name: Bookings - name: Blog - name: Reports paths: /v1/students: post: tags: - Students & Parents summary: Create Student description: >- Create a student account (name, subjects, phone, address, placement) and optionally a linked parent. `email` is optional (omit → no-email placeholder account, invite later); when a real email is present and `send_invite` (default true) is set, emails a set-password link. Cross-org placement targets return 404. operationId: create_student_v1_students_post parameters: - name: Idempotency-Key in: header required: false schema: anyOf: - type: string - type: 'null' title: Idempotency-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StudentCreate' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccountCreateResult' '401': description: Missing, malformed, revoked, or expired credentials. content: application/json: schema: $ref: '#/components/schemas/ApiError' '403': description: The credential lacks the scope this endpoint requires. content: application/json: schema: $ref: '#/components/schemas/ApiError' '422': description: Validation error — `error.details.errors` lists the fields. content: application/json: schema: $ref: '#/components/schemas/ApiError' '429': description: >- Rate limit exceeded — honour Retry-After and the RateLimit-* headers. content: application/json: schema: $ref: '#/components/schemas/ApiError' components: schemas: StudentCreate: properties: full_name: type: string title: Full Name email: anyOf: - type: string - type: 'null' title: Email send_invite: type: boolean title: Send Invite default: true phone_number: anyOf: - type: string - type: 'null' title: Phone Number phone_country_code: anyOf: - type: string - type: 'null' title: Phone Country Code math_level_ids: items: type: string type: array title: Math Level Ids addresses: items: $ref: '#/components/schemas/AddressIn' type: array title: Addresses placement: anyOf: - $ref: '#/components/schemas/PlacementIn' - type: 'null' parent: anyOf: - $ref: '#/components/schemas/ParentIn' - type: 'null' additionalProperties: false type: object required: - full_name title: StudentCreate description: >- POST /v1/students → mint a student account with a known name + fields, place them, and optionally create + link a parent. Requires scope `accounts:write`. `email` is OPTIONAL: omit it to create the account now (against an internal placeholder address) and add a real email + invite later. `send_invite` (default true) controls whether a set-password email is sent when a real email is present — a no-email account is never emailed regardless. AccountCreateResult: properties: results: items: $ref: '#/components/schemas/ProvisionedAccount' type: array title: Results type: object required: - results title: AccountCreateResult description: >- Result of POST /v1/students|tutors|parents — one entry per account processed (a student with a nested parent returns two). ApiError: description: Canonical error envelope for every /v1 error response (4xx/5xx). properties: error: $ref: '#/components/schemas/ApiErrorBody' required: - error title: ApiError type: object AddressIn: properties: label: anyOf: - type: string - type: 'null' title: Label street_address: anyOf: - type: string - type: 'null' title: Street Address suburb: anyOf: - type: string - type: 'null' title: Suburb state: anyOf: - type: string - type: 'null' title: State postcode: anyOf: - type: string - type: 'null' title: Postcode is_default: anyOf: - type: boolean - type: 'null' title: Is Default additionalProperties: false type: object title: AddressIn description: >- A student address (locations row). Multiple allowed; at most one is_default. PlacementIn: properties: type: type: string enum: - add_to_org - add_to_1on1 - add_to_classroom - add_to_group title: Type default: add_to_org tutor_id: anyOf: - type: string - type: 'null' title: Tutor Id classroom_id: anyOf: - type: string - type: 'null' title: Classroom Id group_id: anyOf: - type: string - type: 'null' title: Group Id active_math_level_id: anyOf: - type: string - type: 'null' title: Active Math Level Id additionalProperties: false type: object title: PlacementIn description: >- Where to place a created student. Targets are org-scoped (cross-org → 404). ParentIn: properties: full_name: type: string title: Full Name email: anyOf: - type: string - type: 'null' title: Email phone_number: anyOf: - type: string - type: 'null' title: Phone Number phone_country_code: anyOf: - type: string - type: 'null' title: Phone Country Code additionalProperties: false type: object required: - full_name title: ParentIn description: >- A parent to create + link to the student being created (nested in StudentCreate). `email` is optional — omit it to mint a no-email (placeholder) parent account. ProvisionedAccount: properties: status: type: string title: Status user_id: anyOf: - type: string - type: 'null' title: User Id email: anyOf: - type: string - type: 'null' title: Email action: anyOf: - type: string - type: 'null' title: Action reason: anyOf: - type: string - type: 'null' title: Reason invited: anyOf: - type: boolean - type: 'null' title: Invited placeholder: anyOf: - type: boolean - type: 'null' title: Placeholder type: object required: - status title: ProvisionedAccount description: One row of an account-create result. ApiErrorBody: description: The `error` object every /v1 error response carries. properties: code: description: >- Stable machine-readable error code: bad_request, unauthorized, forbidden, not_found, conflict, validation_error, rate_limited, or internal_error. examples: - not_found title: Code type: string message: description: Human-readable explanation, safe to surface to end users. examples: - Session not found title: Message type: string status: description: The HTTP status code, repeated in the body. examples: - 404 title: Status type: integer details: additionalProperties: true description: >- Error-specific context. 422 carries the field errors under `errors`; 429 carries `retry_after_seconds`. title: Details type: object required: - code - message - status title: ApiErrorBody type: object securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: Org API key as `Token token=ei_live_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.