> ## 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.

# Lookup User

> Look up a single user by email or phone. At least one of `email`/`phone` is
required (422 otherwise). Only returns a user who is an accepted member of your
org, or an org-affiliated student — a user in a different org is indistinguishable
from a non-existent one (404, no existence leak).



## OpenAPI

````yaml /openapi.json get /v1/users
openapi: 3.1.0
info:
  title: EquateIt Public API
  description: >-
    REST API for EquateIt 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 EquateIt 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/users:
    get:
      tags:
        - Students & Parents
      summary: Lookup User
      description: >-
        Look up a single user by email or phone. At least one of `email`/`phone`
        is

        required (422 otherwise). Only returns a user who is an accepted member
        of your

        org, or an org-affiliated student — a user in a different org is
        indistinguishable

        from a non-existent one (404, no existence leak).
      operationId: lookup_user_v1_users_get
      parameters:
        - name: email
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Exact email (case-insensitive)
            title: Email
          description: Exact email (case-insensitive)
        - name: phone
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Exact phone number
            title: Phone
          description: Exact phone number
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserLookup'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    UserLookup:
      properties:
        id:
          type: string
          title: Id
        first_name:
          anyOf:
            - type: string
            - type: 'null'
          title: First Name
        last_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Name
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
        account_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Account Type
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
      type: object
      required:
        - id
      title: UserLookup
      description: >-
        GET /v1/users — a user (staff or org-affiliated student/parent) matched
        by

        email or phone. The lookup never leaks cross-org existence (404
        otherwise).
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Org API key as `Token token=ei_live_...`

````