openapi.yaml

openapi: 3.0.0
info:
  title: Intra 42 API
  description: |
    This is the OpenAPI specification for the Intra 42 API v2.
  version: 2.0.0
servers:
  - url: https://api.intra.42.fr/v2
    description: Production
paths:
  /closes:
    get:
      operationId: getCloses
      summary: Get a list of closes
      security:
        - OAuth2:
            - public
      parameters:
        - name: sort
          in: query
          description: |
            The sort field. Sorted by created_at desc, id desc by default.
            Must be one of: id, user_id, closer_id, reason, state, created_at, updated_at, kind, end_at, jid.
          required: false
          schema:
            type: string
            enum:
              - id
              - user_id
              - closer_id
              - reason
              - state
              - created_at
              - updated_at
              - kind
              - end_at
              - jid
        - name: filter
          in: query
          description: |
            Filtering on one or more fields. Must be one of: id, user_id, closer_id, reason, state, created_at, updated_at, kind, end_at, jid, campus_id, end.
          required: false
          schema:
            type: object
            additionalProperties:
              type: string
          style: deepObject
          explode: true
        - name: range
          in: query
          description: |
            Select on a particular range. Must be one of: id, user_id, closer_id, reason, state, created_at, updated_at, kind, end_at, jid.
          required: false
          schema:
            type: object
            additionalProperties:
              type: string
          style: deepObject
          explode: true
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/per_page'
        - $ref: '#/components/parameters/page_number'
        - $ref: '#/components/parameters/page_size'
      responses:
        '200':
          description: A list of closes
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CloseResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
  /closes/{id}:
    get:
      operationId: getCloseById
      summary: Get a close by ID
      security:
        - OAuth2:
            - public
      parameters:
        - name: id
          in: path
          required: true
          description: The ID of the close
          schema:
            type: integer
      responses:
        '200':
          description: A close object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloseResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
  /internships:
    get:
      operationId: getInternships
      summary: Get a list of internships
      security:
        - OAuth2:
            - public
      parameters:
        - name: sort
          in: query
          description: |
            The sort field. Sorted by id desc by default.
            Must be one of: id, user_id, administration_id, offer_id, language_id, state, days, user_address, user_postal, user_city, user_country, company_name, company_boss_user_first_name, company_boss_user_last_name, company_boss_user_email, company_boss_user_phone, company_user_first_name, company_user_last_name, company_user_post, company_user_email, company_user_phone, company_address, company_postal, company_city, company_country, company_siret, internship_address, internship_postal, internship_city, internship_country, contract_type, subject, start_at, end_at, duration, nb_days, nb_hours, movement, salary, currency, breach_at, convention, created_at, updated_at, anti_grav_units_user_id.
            Example: -updated_at,anti_grav_units_user_id (to sort by updated_at descending and anti_grav_units_user_id ascending)
          required: false
          schema:
            type: string
        - name: filter
          in: query
          description: |
            Filtering on one or more fields.
            Must be one of: id, user_id, administration_id, offer_id, language_id, state, days, user_address, user_postal, user_city, user_country, company_name, company_boss_user_first_name, company_boss_user_last_name, company_boss_user_email, company_boss_user_phone, company_user_first_name, company_user_last_name, company_user_post, company_user_email, company_user_phone, company_address, company_postal, company_city, company_country, company_siret, internship_address, internship_postal, internship_city, internship_country, contract_type, subject, start_at, end_at, duration, nb_days, nb_hours, movement, salary, currency, breach_at, convention, created_at, updated_at, anti_grav_units_user_id.
            Example: filter[id]=a_value,another_value (to filter on internships with id matching a_value or another_value)
          required: false
          schema:
            type: object
            additionalProperties:
              type: string
          style: deepObject
          explode: true
        - name: range
          in: query
          description: |
            Select on a particular range.
            Must be one of: id, user_id, administration_id, offer_id, language_id, state, days, user_address, user_postal, user_city, user_country, company_name, company_boss_user_first_name, company_boss_user_last_name, company_boss_user_email, company_boss_user_phone, company_user_first_name, company_user_last_name, company_user_post, company_user_email, company_user_phone, company_address, company_postal, company_city, company_country, company_siret, internship_address, internship_postal, internship_city, internship_country, contract_type, subject, start_at, end_at, duration, nb_days, nb_hours, movement, salary, currency, breach_at, convention, created_at, updated_at.
            Example: range[status]=min_value,max_value (to range on internships with status field between min_value and max_value)
          required: false
          schema:
            type: object
            additionalProperties:
              type: string
          style: deepObject
          explode: true
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/per_page'
        - $ref: '#/components/parameters/page_number'
        - $ref: '#/components/parameters/page_size'
      responses:
        '200':
          description: A list of internships
          headers:
            Link:
              $ref: '#/components/headers/Link'
            X-Page:
              $ref: '#/components/headers/X-Page'
            X-Per-Page:
              $ref: '#/components/headers/X-Per-Page'
            X-Total:
              $ref: '#/components/headers/X-Total'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InternshipResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
  /languages/{id}:
    get:
      operationId: getLanguageById
      summary: Get a language by ID
      security:
        - OAuth2:
            - public
      parameters:
        - name: id
          in: path
          required: true
          description: The ID of the language
          schema:
            type: integer
      responses:
        '200':
          description: A language object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LanguageResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
  /users:
    get:
      operationId: getUsers
      summary: Get a list of users
      security:
        - OAuth2:
            - public
      parameters:
        - name: sort
          in: query
          description: |
            The sort field. Sorted by id desc by default.
            Must be one of: id, login, email, encrypted_password, reset_password_token, reset_password_sent_at, created_at, updated_at, image, first_name, last_name, pool_year, pool_month, kind, status, otp_secret_key, otp_tmp, otp_activated, otp_backup_passwords, slack_team, slack_login, slack_mail, slack_code_validation, slack_validated_at, token_id, email_stop, linked_user_id, usual_first_name, last_seen_at, password_changed_at, encrypted_single_usage_password, first_warn_anon_sent_at, second_warn_anon_sent_at, alumnized_at, anonymized_at.
            Example: -alumnized_at,anonymized_at (to sort on alumnized_at descending and anonymized_at ascending)
          required: false
          schema:
            type: string
        - name: filter
          in: query
          description: |
            Filtering on one or more fields.
            Must be one of: id, login, email, created_at, updated_at, pool_year, pool_month, kind, status, primary_campus_id, first_name, last_name, alumni?, staff?.
            Example: filter[id]=a_value,another_value (to filter on users with id matching a_value or another_value)
          required: false
          schema:
            type: object
            additionalProperties:
              type: string
          style: deepObject
          explode: true
        - name: range
          in: query
          description: |
            Select on a particular range.
            Must be one of: id, login, email, created_at, updated_at, pool_year, pool_month, kind, status.
            Example: range[status]=min_value,max_value (to range on users with status field between min_value and max_value)
          required: false
          schema:
            type: object
            additionalProperties:
              type: string
          style: deepObject
          explode: true
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/per_page'
        - $ref: '#/components/parameters/page_number'
        - $ref: '#/components/parameters/page_size'
      responses:
        '200':
          description: A list of users
          headers:
            Link:
              $ref: '#/components/headers/Link'
            X-Page:
              $ref: '#/components/headers/X-Page'
            X-Per-Page:
              $ref: '#/components/headers/X-Per-Page'
            X-Total:
              $ref: '#/components/headers/X-Total'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LightUserResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
  /users/{id}:
    get:
      operationId: getUserById
      summary: Get a user by ID
      security:
        - OAuth2:
            - public
      parameters:
        - name: id
          in: path
          required: true
          description: The ID of the user
          schema:
            type: string
      responses:
        '200':
          description: A user object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
  /users/{id}/user_candidature:
    get:
      operationId: getUserCandidatureById
      summary: Get user candidature information
      security:
        - OAuth2:
            - public
      parameters:
        - name: id
          in: path
          required: true
          description: The ID of the user
          schema:
            type: string
      responses:
        '200':
          description: User candidature information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCandidatureResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
  /users/{user_id}/closes:
    get:
      operationId: getClosesByUserId
      summary: Get a list of closes by user id
      security:
        - OAuth2:
            - public
      parameters:
        - name: user_id
          in: path
          required: true
          description: The user id
          schema:
            type: integer
        - name: sort
          in: query
          description: |
            The sort field. Sorted by created_at desc, id desc by default.
            Must be one of: id, user_id, closer_id, reason, state, created_at, updated_at, kind, end_at, jid.
          required: false
          schema:
            type: string
            enum:
              - id
              - user_id
              - closer_id
              - reason
              - state
              - created_at
              - updated_at
              - kind
              - end_at
              - jid
        - name: filter
          in: query
          description: |
            Filtering on one or more fields. Must be one of: id, user_id, closer_id, reason, state, created_at, updated_at, kind, end_at, jid, campus_id, end.
          required: false
          schema:
            type: object
            additionalProperties:
              type: string
          style: deepObject
          explode: true
        - name: range
          in: query
          description: |
            Select on a particular range. Must be one of: id, user_id, closer_id, reason, state, created_at, updated_at, kind, end_at, jid.
          required: false
          schema:
            type: object
            additionalProperties:
              type: string
          style: deepObject
          explode: true
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/per_page'
        - $ref: '#/components/parameters/page_number'
        - $ref: '#/components/parameters/page_size'
      responses:
        '200':
          description: A list of closes
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CloseResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  schemas:
    AchievementResponse:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          type: string
        tier:
          type: string
        kind:
          type: string
        visible:
          type: boolean
        image:
          type: string
        nbr_of_success:
          type: integer
          nullable: true
        users_url:
          type: string
          format: uri
      required:
        - id
        - name
        - description
        - tier
        - kind
        - visible
        - image
        - users_url
    CampusResponse:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        time_zone:
          type: string
        language:
          $ref: '#/components/schemas/LanguageResponse'
        users_count:
          type: integer
        vogsphere_id:
          type: integer
        country:
          type: string
        address:
          type: string
        zip:
          type: string
        city:
          type: string
        website:
          type: string
          format: uri
        facebook:
          type: string
          format: uri
        twitter:
          type: string
          format: uri
        active:
          type: boolean
        public:
          type: boolean
        email_extension:
          type: string
        default_hidden_phone:
          type: boolean
      required:
        - id
        - name
        - time_zone
        - users_count
        - vogsphere_id
        - country
        - city
        - active
        - public
        - email_extension
    CampusUserResponse:
      type: object
      properties:
        id:
          type: integer
        user_id:
          type: integer
        campus_id:
          type: integer
        is_primary:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - user_id
        - campus_id
        - is_primary
        - created_at
        - updated_at
    CloseResponse:
      type: object
      properties:
        id:
          type: integer
        reason:
          type: string
        state:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        end_at:
          type: string
          format: date-time
          nullable: true
        community_services:
          type: array
          items:
            $ref: '#/components/schemas/CommunityServiceResponse'
          nullable: false
        kind:
          type: string
          enum:
            - agu
            - other
            - deserter
            - pace_unknown
            - black_hole
            - serious_misconduct
            - social_security
            - non_admitted
        user:
          $ref: '#/components/schemas/LightUserResponse'
        closer:
          $ref: '#/components/schemas/LightUserResponse'
      required:
        - id
        - reason
        - state
        - created_at
        - updated_at
        - community_services
        - user
        - closer
        - kind
    CommunityServiceResponse:
      type: object
      properties:
        id:
          type: integer
        duration:
          type: integer
        schedule_at:
          type: string
          format: date-time
        occupation:
          type: string
        state:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
      required:
        - id
        - duration
        - schedule_at
        - occupation
        - state
        - created_at
        - updated_a
    CursusResponse:
      type: object
      properties:
        id:
          type: integer
        created_at:
          type: string
          format: date-time
        name:
          type: string
        slug:
          type: string
        kind:
          type: string
      required:
        - id
        - created_at
        - name
        - slug
        - kind
    CursusUserResponse:
      type: object
      properties:
        id:
          type: integer
        begin_at:
          type: string
          format: date-time
        end_at:
          type: string
          format: date-time
        grade:
          type: string
        level:
          type: number
          format: double
        skills:
          type: array
          items:
            $ref: '#/components/schemas/SkillResponse'
        cursus_id:
          type: integer
        cursus:
          $ref: '#/components/schemas/CursusResponse'
        has_coalition:
          type: boolean
        blackholed_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - begin_at
        - grade
        - level
        - cursus_id
        - cursus
        - has_coalition
        - created_at
        - updated_at
        - skills
    Error:
      type: object
      properties:
        status:
          type: integer
          description: HTTP status code
        error:
          type: string
          description: Error message
      required:
        - status
        - error
      example:
        status: 401
        error: The access token is invalid
    GroupResponse:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
      required:
        - id
        - name
    InternshipResponse:
      type: object
      properties:
        id:
          type: integer
        administration_id:
          type: integer
        offer_id:
          type: integer
          nullable: true
        language_id:
          type: integer
        state:
          type: string
        days:
          type: string
        user_address:
          type: string
        user_postal:
          type: string
        user_city:
          type: string
        user_country:
          type: string
        company_name:
          type: string
        company_boss_user_first_name:
          type: string
        company_boss_user_last_name:
          type: string
        company_boss_user_email:
          type: string
        company_boss_user_phone:
          type: string
        company_user_first_name:
          type: string
        company_user_last_name:
          type: string
        company_user_post:
          type: string
        company_user_email:
          type: string
        company_user_phone:
          type: string
        company_address:
          type: string
        company_postal:
          type: string
        company_city:
          type: string
        company_country:
          type: string
        company_siret:
          type: string
        internship_address:
          type: string
        internship_postal:
          type: string
        internship_city:
          type: string
        internship_country:
          type: string
        contract_type:
          type: string
        subject:
          type: string
        start_at:
          type: string
          format: date-time
        end_at:
          type: string
          format: date-time
        duration:
          type: integer
        nb_days:
          type: integer
        nb_hours:
          type: integer
        salary:
          anyOf:
            - type: integer
            - type: number
        currency:
          type: string
        breach_at:
          type: string
          format: date-time
          nullable: true
        convention:
          type: object
          properties:
            convention:
              type: object
              properties:
                url:
                  type: string
                  nullable: true
              required:
                - url
          required:
            - convention
        convention_uri:
          type: string
          format: url
          nullable: true
        projects_user:
          type: integer
          nullable: true
        user:
          $ref: '#/components/schemas/LightUserResponse'
      required:
        - id
        - administration_id
        - offer_id
        - language_id
        - state
        - days
        - user_address
        - user_postal
        - user_city
        - user_country
        - company_name
        - company_boss_user_first_name
        - company_boss_user_last_name
        - company_boss_user_email
        - company_boss_user_phone
        - company_user_first_name
        - company_user_last_name
        - company_user_post
        - company_user_email
        - company_user_phone
        - company_address
        - company_postal
        - company_city
        - company_country
        - company_siret
        - internship_address
        - internship_postal
        - internship_city
        - internship_country
        - contract_type
        - subject
        - start_at
        - end_at
        - duration
        - nb_days
        - nb_hours
        - salary
        - currency
        - breach_at
        - convention
        - convention_uri
        - user
    IntraDateTime:
      type: string
      format: date-time
      example: '2017-03-25T13:30:00.000Z'
      x-go-type: IntraTime
    LanguageResponse:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        identifier:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - name
        - identifier
        - created_at
        - updated_at
    LanguageUserResponse:
      type: object
      properties:
        id:
          type: integer
        language_id:
          type: integer
        user_id:
          type: integer
        position:
          type: integer
        created_at:
          type: string
          format: date-time
      required:
        - id
        - language_id
        - user_id
        - position
        - created_at
    LightUserResponse:
      type: object
      properties:
        id:
          type: integer
          description: The unique identifier of the user.
        login:
          type: string
          description: The login name of the user.
        first_name:
          type: string
          description: The first name of the user.
        usual_first_name:
          type: string
          description: The usual first name of the user, first_name if none.
          nullable: true
        usual_full_name:
          type: string
          description: The usual full name of the user, usually usual_first_name or first_name + last_name.
        last_name:
          type: string
          description: The last name of the user.
        email:
          type: string
          description: The email address of the user.
        url:
          type: string
          format: uri
          description: The URL to the user's resource.
        phone:
          type: string
          description: The phone number of the user (always hidden).
        displayname:
          type: string
          description: The display name of the user.
        kind:
          type: string
          description: The kind of user (e.g., student, admin, external).
          enum:
            - student
            - admin
            - external
        image:
          $ref: '#/components/schemas/UserImageResponse'
        staff?:
          type: boolean
          description: Indicates if the user is staff.
        correction_point:
          type: integer
          description: The user's correction points.
        pool_month:
          type: string
          description: The month of the user's pool.
        pool_year:
          type: string
          description: The year of the user's pool.
        location:
          type: string
          description: The location of the user.
          nullable: true
        wallet:
          type: integer
          description: The user's wallet balance.
        anonymize_date:
          type: string
          format: date-time
          description: The date when user data will be anonymized.
        data_erasure_date:
          type: string
          format: date-time
          description: The date when user data will be erased.
        created_at:
          type: string
          format: date-time
          description: The user creation timestamp.
        updated_at:
          type: string
          format: date-time
          description: The last user update timestamp.
        alumnized_at:
          type: string
          format: date-time
          description: The date when the user became an alumnus.
          nullable: true
        alumni?:
          type: boolean
          description: Indicates if the user is an alumnus.
        active:
          type: boolean
          description: Indicates if the user is active.
      required:
        - id
        - login
        - first_name
        - last_name
        - usual_full_name
        - email
        - url
        - displayname
        - kind
        - correction_point
        - pool_month
        - pool_year
        - wallet
        - anonymize_date
        - data_erasure_date
        - created_at
        - updated_at
        - alumni?
        - active
      example:
        id: 39962
        email: malallai@student.42.fr
        login: malallai
        first_name: Malo
        last_name: Allain
        usual_full_name: Malo Allain
        usual_first_name: null
        url: https://api.intra.42.fr/v2/users/malallai
        phone: hidden
        displayname: Malo Allain
        kind: student
        image:
          link: https://cdn.intra.42.fr/users/39a641ed152b654cfbff5c5864eb05c1/malallai.jpg
          versions:
            large: https://cdn.intra.42.fr/users/a818d7a54298d333411557d0b55b61b3/large_malallai.jpg
            medium: https://cdn.intra.42.fr/users/53691acd1e0ea75b782ddbe121c17423/medium_malallai.jpg
            small: https://cdn.intra.42.fr/users/617de91b59fd7e59ecaf6470a4b37645/small_malallai.jpg
            micro: https://cdn.intra.42.fr/users/6f74b46e2016b0e6c41fa05b5952e17c/micro_malallai.jpg
        staff: false
        correction_point: 4
        pool_month: august
        pool_year: '2018'
        location: null
        wallet: 290
        anonymize_date: '2025-10-24T00:00:00.000+02:00'
        data_erasure_date: '2025-10-24T00:00:00.000+02:00'
        created_at: '2018-07-17T08:57:33.128Z'
        updated_at: '2022-09-27T18:48:28.207Z'
        alumnized_at: null
        alumni?: false
        active: true
    PatronageResponse:
      type: object
      properties:
        id:
          type: integer
        user_id:
          type: integer
        godson_id:
          type: integer
        godfather_id:
          type: integer
        ongoing:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - ongoing
        - created_at
        - updated_at
    ProjectLightResponse:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        slug:
          type: string
        parent_id:
          type: integer
          nullable: true
      required:
        - id
        - name
        - slug
    ProjectUserResponse:
      type: object
      properties:
        id:
          type: integer
        occurrence:
          type: integer
        final_mark:
          type: integer
          nullable: true
        status:
          type: string
        validated:
          type: boolean
          nullable: true
        current_team_id:
          type: integer
        project:
          $ref: '#/components/schemas/ProjectLightResponse'
        cursus_ids:
          type: array
          items:
            type: integer
        marked_at:
          type: string
          format: date-time
          nullable: true
        marked:
          type: boolean
        retriable_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - occurrence
        - status
        - marked
        - cursus_ids
        - created_at
        - updated_at
    RoleResponse:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
      required:
        - id
        - name
    SkillResponse:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        level:
          type: number
          format: double
      required:
        - id
        - name
        - level
    TitleResponse:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
      required:
        - id
        - name
    TitleUserResponse:
      type: object
      properties:
        id:
          type: integer
        user_id:
          type: integer
        title_id:
          type: integer
        selected:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - user_id
        - title_id
        - selected
        - created_at
        - updated_at
    UserCandidatureResponse:
      type: object
      properties:
        id:
          type: integer
        user_id:
          type: integer
        birth_date:
          type: string
          nullable: false
          format: date
        gender:
          type: string
          nullable: true
          enum:
            - male
            - female
            - other
        zip_code:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        birth_city:
          type: string
        birth_country:
          type: string
          nullable: true
        postal_street:
          type: string
        postal_complement:
          type: string
          nullable: true
        postal_city:
          type: string
        postal_zip_code:
          type: string
        postal_country:
          type: string
        contact_affiliation:
          type: string
        contact_last_name:
          type: string
        contact_first_name:
          type: string
        contact_phone1:
          type: string
        contact_phone2:
          type: string
          nullable: true
        max_level_memory:
          type: number
          format: double
          nullable: true
        max_level_logic:
          type: number
          format: double
          nullable: true
        other_information:
          type: string
          nullable: true
        language:
          type: string
        meeting_date:
          nullable: true
          type: string
          allOf:
            - $ref: '#/components/schemas/IntraDateTime'
        piscine_date:
          nullable: true
          type: string
          allOf:
            - $ref: '#/components/schemas/IntraDateTime'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        phone:
          type: string
        email:
          type: string
        pin:
          type: string
        phone_country_code:
          type: string
        hidden_phone:
          type: boolean
      required:
        - id
        - user_id
        - birth_city
        - postal_street
        - postal_city
        - postal_zip_code
        - postal_country
        - contact_affiliation
        - contact_last_name
        - contact_first_name
        - contact_phone1
        - language
        - created_at
        - updated_at
        - phone
        - email
        - pin
        - phone_country_code
        - hidden_phone
      example:
        id: 42
        user_id: 42
        birth_date: '2013-01-01'
        gender: male
        zip_code: '75017'
        country: France
        birth_city: Paris
        birth_country: France
        postal_street: 96 boulevard Bessières
        postal_complement: null
        postal_city: Paris
        postal_zip_code: '75017'
        postal_country: France
        contact_affiliation: Parent
        contact_last_name: Moulinette
        contact_first_name: Norminette
        contact_phone1: '+33600000000'
        contact_phone2: null
        max_level_memory: null
        max_level_logic: null
        other_information: null
        language: fr
        meeting_date: '2020-08-27T07:31:49.431Z'
        piscine_date: null
        created_at: '2020-08-27T07:31:49.431Z'
        updated_at: '2025-07-10T16:16:34.238Z'
        phone: '+33600000000'
        email: tmatis@example.com
        pin: '7777'
        phone_country_code: FR
        hidden_phone: false
    UserImageResponse:
      type: object
      properties:
        link:
          type: string
          format: uri
          description: The URL to the user's image.
        versions:
          type: object
          properties:
            large:
              type: string
              format: uri
              description: URL to the large version of the user's image.
            medium:
              type: string
              format: uri
              description: URL to the medium version of the user's image.
            small:
              type: string
              format: uri
              description: URL to the small version of the user's image.
            micro:
              type: string
              format: uri
              description: URL to the micro version of the user's image.
          required:
            - large
            - medium
            - small
            - micro
      required:
        - link
        - versions
    UserResponse:
      allOf:
        - $ref: '#/components/schemas/LightUserResponse'
        - type: object
          properties:
            groups:
              type: array
              items:
                $ref: '#/components/schemas/GroupResponse'
            cursus_users:
              type: array
              items:
                $ref: '#/components/schemas/CursusUserResponse'
            projects_users:
              type: array
              items:
                $ref: '#/components/schemas/ProjectUserResponse'
            languages_users:
              type: array
              items:
                $ref: '#/components/schemas/LanguageUserResponse'
            achievements:
              type: array
              items:
                $ref: '#/components/schemas/AchievementResponse'
            titles:
              type: array
              items:
                $ref: '#/components/schemas/TitleResponse'
            titles_users:
              type: array
              items:
                $ref: '#/components/schemas/TitleUserResponse'
            patroned:
              type: array
              items:
                $ref: '#/components/schemas/PatronageResponse'
            patroning:
              type: array
              items:
                $ref: '#/components/schemas/PatronageResponse'
            roles:
              type: array
              items:
                $ref: '#/components/schemas/RoleResponse'
            campus:
              type: array
              items:
                $ref: '#/components/schemas/CampusResponse'
            campus_users:
              type: array
              items:
                $ref: '#/components/schemas/CampusUserResponse'
          required:
            - groups
            - cursus_users
            - projects_users
            - languages_users
            - achievements
            - titles
            - titles_users
            - patroned
            - patroning
            - roles
            - campus
            - campus_users
          example:
            id: 77640
            email: tmatis@student.42.fr
            login: tmatis
            first_name: Theo
            last_name: Matis
            usual_full_name: Theo Matis
            usual_first_name: Theo
            url: https://api.intra.42.fr/v2/users/tmatis
            phone: hidden
            displayname: Theo Matis
            kind: student
            image:
              link: https://cdn.intra.42.fr/users/rand/tmatis.jpg
              versions:
                large: https://cdn.intra.42.fr/users/rand/large_tmatis.jpg
                medium: https://cdn.intra.42.fr/users/rand/medium_tmatis.jpg
                small: https://cdn.intra.42.fr/users/rand/small_tmatis.jpg
                micro: https://cdn.intra.42.fr/users/rand/micro_tmatis.jpg
            staff: false
            correction_point: -2
            pool_month: september
            pool_year: '2020'
            location: null
            wallet: 430
            anonymize_date: '2028-12-10T00:00:00.000+01:00'
            data_erasure_date: '2028-12-10T00:00:00.000+01:00'
            created_at: '2020-08-27T07:31:49.397Z'
            updated_at: '2025-10-03T14:08:47.122Z'
            alumnized_at: null
            alumni?: false
            active: true
            groups:
              - id: 72
                name: Launchpad Alumni
            cursus_users:
              - id: 99439
                begin_at: '2020-09-07T06:42:00.000Z'
                end_at: '2020-10-02T16:42:00.000Z'
                grade: Pisciner
                level: 11.04
                skills:
                  - id: 4
                    name: Unix
                    level: 12.37
                cursus_id: 9
                cursus:
                  id: 9
                  created_at: '2015-11-04T10:58:13.979Z'
                  name: C Piscine
                  slug: c-piscine
                  kind: piscine
                has_coalition: true
                blackholed_at: null
                created_at: '2020-08-27T07:31:50.934Z'
                updated_at: '2020-08-31T17:14:10.779Z'
            projects_users:
              - id: 3474475
                occurrence: 0
                final_mark: null
                status: in_progress
                validated: null
                current_team_id: 6251895
                project:
                  id: 1381
                  name: taskmaster
                  slug: 42cursus-taskmaster
                  parent_id: null
                cursus_ids:
                  - 21
                marked_at: null
                marked: false
                retriable_at: null
                created_at: '2024-01-12T12:03:35.971Z'
                updated_at: '2025-07-23T17:28:02.142Z'
            languages_users:
              - id: 1083223
                language_id: 1
                user_id: 77640
                position: 2
                created_at: '2024-12-23T12:36:17.805Z'
            achievements:
              - id: 41
                name: All work and no play makes Jack a dull boy
                description: Logged for a total of 90 hours over a week.
                tier: none
                kind: scolarity
                visible: true
                image: /uploads/achievement/image/41/SCO001.svg
                nbr_of_success: null
                users_url: https://api.intra.42.fr/v2/achievements/41/users
            titles:
              - id: 21
                name: '%login, Khonvoum'
            titles_users:
              - id: 42843
                user_id: 77640
                title_id: 2098
                selected: false
                created_at: '2024-10-11T09:26:25.755Z'
                updated_at: '2024-10-11T09:26:25.755Z'
            partnerships: []
            patroned:
              - id: 3241
                user_id: 40284
                godson_id: 77640
                ongoing: true
                created_at: '2020-09-07T06:42:00.000Z'
                updated_at: '2022-07-14T06:54:47.852Z'
            patroning:
              - id: 2347
                user_id: 60092
                godfather_id: 40284
                ongoing: true
                created_at: '2019-12-10T18:13:46.543Z'
                updated_at: '2022-07-14T06:54:47.852Z'
            roles:
              - id: 5
                name: Basic Tutor
            campus:
              - id: 1
                name: Paris
                time_zone: Europe/Paris
                language:
                  id: 1
                  name: Français
                  identifier: fr
                  created_at: '2014-11-02T16:43:38.466Z'
                  updated_at: '2025-12-11T03:00:51.723Z'
                users_count: 39708
                vogsphere_id: 1
                country: France
                address: 96, boulevard Bessières
                zip: '75017'
                city: Paris
                website: http://www.42.fr/
                facebook: https://facebook.com/42born2code
                twitter: https://twitter.com/42born2code
                active: true
                public: true
                email_extension: 42.fr
                default_hidden_phone: true
            campus_users:
              - id: 68938
                user_id: 77640
                campus_id: 1
                is_primary: true
                created_at: '2020-08-27T07:31:49.419Z'
                updated_at: '2024-06-06T16:11:52.102Z'
  parameters:
    page:
      name: page
      in: query
      description: |
        Page number (1-based). The 42 API paginates index endpoints and defaults to 30 items per page.
        You can also use the `per_page` parameter to set the page size (up to 100 for many endpoints).
      required: false
      schema:
        type: integer
        minimum: 1
    page_number:
      name: page[number]
      in: query
      description: |
        Alternate pagination style using `page[number]` (1-based page index). Can be used together with `page[size]`.
      required: false
      schema:
        type: integer
        minimum: 1
    page_size:
      name: page[size]
      in: query
      description: |
        Alternate pagination style to set the page size (maximum depends on endpoint, commonly up to 100).
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
    per_page:
      name: per_page
      in: query
      description: |
        Number of items per page. Maximum is generally 100 but some endpoints limit this for technical reasons.
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
  headers:
    Link:
      description: |
        RFC5988 Web Linking header containing `first`, `prev`, `next` and `last` links when available.
        Example: <https://api.intra.42.fr/v2/Users?page=2>; rel="next", <https://api.intra.42.fr/v2/Users?page=1>; rel="prev"
      schema:
        type: string
    X-Page:
      description: The current page number.
      schema:
        type: integer
    X-Per-Page:
      description: The current pagination length (items per page).
      schema:
        type: integer
    X-Total:
      description: The total number of pages available for the resource.
      schema:
        type: integer
  responses:
    ErrorResponse:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    OAuth2:
      type: oauth2
      description: OAuth2 authentication using Bearer tokens.
      flows:
        clientCredentials:
          tokenUrl: https://api.intra.42.fr/oauth/token
          scopes:
            public: access the user public data
            projects: manage teams, slots and all projects related stuff
            profile: manage user data
            elearning: manage media related stuff
            tig: manage community services
            forum: manage topics and messages
        authorizationCode:
          authorizationUrl: https://api.intra.42.fr/oauth/authorize
          tokenUrl: https://api.intra.42.fr/oauth/token
          scopes:
            public: access the user public data
            projects: manage teams, slots and all projects related stuff
            profile: manage user data
            elearning: manage media related stuff
            tig: manage community services
            forum: manage topics and messages