Blackbaud Admissions API

openapi: 3.2.0
info:
  title: 'Blackbaud SKY API: School Admissions API'
  description: This API is used to provide access to school information such as users, academics, admissions, athletics, content, lists, and general school info.
  version: '1.0'
  x-apievangelist-provenance:
    source: https://developer.sky.blackbaud.com/developer/apis/school
    method: assembled from Blackbaud's public API Management developer data API (operations, parameters, representations, examples, stored definitions); nothing authored
    assembled: '2026-10-14'
servers:
- url: https://api.sky.blackbaud.com/school
security:
- Bb-Api-Subscription-Key: []
  OAuth2: []
tags:
- name: Admissions
paths:
  /v1/admissions/candidates:
    post:
      operationId: V1AdmissionsCandidatesPost
      summary: Admissions candidate create (Legacy)
      description: 'Creates a new admissions candidate record.


        Returns the ID of the newly created candidate.


        Requires one of the following roles in the Education Management system:


        Admissions Manager


        Admissions Staff'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CandidateCreate'
            example:
              user_id: 0
              entering_year: string
              entering_grade_id: 0
              checklist_id: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1AdmissionsCandidatesPost200ApplicationJsonResponse'
              example: 450924
      tags:
      - Admissions
    get:
      operationId: V1AdmissionsCandidatesGet
      summary: Admissions candidates (Legacy)
      description: 'Returns a collection of admissions candidates.


        Requires one of the following roles in the Education Management system:


        Admissions Manager


        Platform Manager


        SKY API Data Sync


        NOTE: The following fields have been deprecated and are no longer returned as of 01/01/2023.


        school_decision


        school_decision_type


        candidate_decision


        candidate_decision_type


        Use the school decision and candidate decision objects instead.


        NOTE: The filter for school_year_id has been replaced by school_year.


        The school_year_id filter has been deprecated and no longer functions as of 01/01/2023.'
      parameters:
      - name: school_year
        in: query
        required: false
        schema:
          type: string
        description: The school year for which to return results.  Corresponds to ```school_year_label``` in the <a href="https://developer.sky.blackbaud.com/docs/services/school/operations/v1yearsget">Year list</a>.  Default is current year.
      - name: status_ids
        in: query
        required: false
        schema:
          type: string
        description: One or more comma delimited status Id(s) to filter results on.  Corresponds to ```id``` in the <a href="https://developer.sky.blackbaud.com/docs/services/school/operations/V1AdmissionsStatusGet">Status list</a>.  Default is no status Id filter.
      - name: modified_date
        in: query
        required: false
        schema:
          type: string
        description: 'The date last modified to filter results to on or after. Use <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO-8601</a> date format: 2003-04-21. Default is no modified date filter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CandidateReadCollection'
              example:
                count: 1
                value:
                - user_id: 12345
                  first_name: James
                  last_name: Dean
                  middle_name: Byron
                  prefix: ''
                  suffix: ''
                  nickname: Jimmy
                  role: Candidate
                  role_id: 4543
                  current_status: Applied
                  status_id: 646
                  entering_year: 2020 - 2021
                  entering_year_id: 4520144
                  entering_grade: '9'
                  entering_grade_id: 544
                  email: JimmyJim@DeansCourt.com
                  comment: Enjoys Chess and Acting
                  parent1_email: Mom@DeansCourt.com
                  parent2_email: Dad@DeansCourt.com
                  international: false
                  school_program: High School Program
                  gender: M
                  ethnicity: Caucasian
                  boarding_or_day: B
                  financial_aid: true
                  admissions_staff_id: 54321
                  admissions_staff: John Smith
                  inquiry_source: Open House
                  inquiry_source_id: 3
                  referral_type: Alum
                  referral_type_id: 1
                  has_iep: false
                  has_504: true
                  created_by: '789789'
                  created: '2023-01-06T11:13:33Z'
                  modified_by: '789789'
                  modified: '2023-01-06T11:13:33Z'
                  preferred_name: Jimmy
                  decision:
                    id: 3213
                    name: Conditionally Accepted
                    decision_type: Accepted
                    decision_type_id: 6
                    date: '2023-01-06T11:13:33Z'
                    expire_date: '2023-01-06T11:13:33Z'
                    comment: Waiting for test results.
                    candidate_response:
                      id: 5430
                      name: Excited to Attend
                      decision_type: Enrolling
                      decision_type_id: 14
                      date: '2023-01-06T11:13:33Z'
                  family_id: 2
                  current_status_date: '2024-03-31T12:00:00Z'
                  application:
                    id: 1
                    date_submitted: '2024-03-31T12:00:00Z'
                    date_processed: '2024-03-31T12:00:00Z'
                    source:
                      id: 1
                      description: Email
                  events:
                  - id: 1
                    name: Open House
                    start_time: '2024-03-31T12:00:00Z'
                    is_registered: true
                    attended: false
                    comment: An eventful comment
                  interviews:
                  - id: 1
                    start_time: '2024-03-31T12:00:00Z'
                    end_time: '2024-03-31T12:00:00Z'
                    interviewer_other: John Bridges
                    rating: 10
                    is_rescheduled: false
                    comment: A candid comment
                  visits:
                  - id: 1
                    start_time: '2024-03-31T12:00:00Z'
                    end_time: '2024-03-31T12:00:00Z'
                    guide_other: John Bridges
                    is_rescheduled: false
                    comment: A candid comment
      tags:
      - Admissions
  /v1/admissions/checklists:
    get:
      operationId: V1AdmissionsChecklistsGet
      summary: Admissions checklists (Legacy)
      description: 'Returns a collection of admissions checklists.


        Use the optional ```search_text``` to apply a case-insensitive search against check lists "name".


        Use the optional ```inactive``` to return only inactive checklists (default is both).


        Requires the following role in the Education Management system:


        Admissions Manager'
      parameters:
      - name: search_text
        in: query
        required: false
        schema:
          type: string
        description: Applies a case-insensitive search against check lists "name".
      - name: inactive
        in: query
        required: false
        schema:
          type: boolean
        description: flag to return only inactive checklists (default is both).
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdmissionsCheckListCollection'
              example:
                count: 1
                value:
                - checklist_id: 45245
                  name: My Checklist
                  is_inactive: false
                  is_locked: false
                  is_sample: false
      tags:
      - Admissions
  /v1/admissions/checkliststatus:
    get:
      operationId: V1AdmissionsCheckliststatusGet
      summary: Admissions checklist status (Legacy)
      description: 'Returns a collection of admissions checklist statuses.


        Requires the following role in the Education Management system:


        Admissions Manager'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdmissionsChecklistStatusCollection'
              example:
                count: 3
                value:
                - status_id: 6
                  status_name: Inquiry
                  ordinal: 10
                - status_id: 143
                  status_name: Applicant
                  ordinal: 20
                - status_id: 1201
                  status_name: Accepted
                  ordinal: 30
      tags:
      - Admissions
  /v1/admissions/status:
    get:
      operationId: V1AdmissionsStatusGet
      summary: Admissions statuses (Legacy)
      description: 'Returns a collection of admissions statuses.


        Requires one of the following roles in the Education Management system:


        Admissions Manager


        Platform Manager


        SKY API Data Sync'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdmissionsStatusesCollection'
              example:
                count: 1
                value:
                - id: 45245
                  description: In Process
                  next_status_id: 45246
      tags:
      - Admissions
components:
  schemas:
    AdmissionsStatusesCollection:
      type: object
      properties:
        count:
          type: integer
          description: The number of items in the collection
          format: int32
          readOnly: true
        next_link:
          type:
          - string
          - 'null'
          description: For paginated responses, the URI for the next page of results
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AdmissionsStatuses'
          description: The set of items included in the response. This may be a subset of the items in the collection
      additionalProperties: false
      description: A Collection
    AdmissionsChecklistStatusCollection:
      type: object
      properties:
        count:
          type: integer
          description: The number of items in the collection
          format: int32
          readOnly: true
        next_link:
          type:
          - string
          - 'null'
          description: For paginated responses, the URI for the next page of results
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AdmissionsChecklistStatus'
          description: The set of items included in the response. This may be a subset of the items in the collection
      additionalProperties: false
      description: A Collection
    AdmissionsChecklistStatus:
      type: object
      properties:
        status_id:
          type:
          - integer
          - 'null'
          description: Identifier for this status
          format: int32
        status_name:
          type:
          - string
          - 'null'
          description: Name of the status
        ordinal:
          type:
          - integer
          - 'null'
          description: Order of the status (lower items are earlier in the order)
          format: int32
      additionalProperties: false
      description: Admissions Checklist Status
    CandidateReadCollection:
      type: object
      properties:
        count:
          type: integer
          description: The number of items in the collection
          format: int32
          readOnly: true
        next_link:
          type:
          - string
          - 'null'
          description: For paginated responses, the URI for the next page of results
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CandidateRead'
          description: The set of items included in the response. This may be a subset of the items in the collection
      additionalProperties: false
      description: A Collection
    SchoolDecisionModel:
      type: object
      properties:
        id:
          type:
          - integer
          - 'null'
          description: ''
          format: int32
        name:
          type:
          - string
          - 'null'
          description: ''
        decision_type:
          type:
          - string
          - 'null'
          description: ''
        decision_type_id:
          type:
          - integer
          - 'null'
          description: ''
          format: int32
        date:
          type:
          - string
          - 'null'
          description: ''
          format: date-time
        expire_date:
          type:
          - string
          - 'null'
          description: ''
          format: date-time
        comment:
          type:
          - string
          - 'null'
          description: ''
        candidate_response:
          $ref: '#/components/schemas/CandidateDecisionModel'
      additionalProperties: false
      description: ''
    AdmissionsStatuses:
      type: object
      properties:
        id:
          type:
          - integer
          - 'null'
          description: Identifier for a given status
          format: int32
        description:
          type:
          - string
          - 'null'
          description: Name of the status
        next_status_id:
          type:
          - integer
          - 'null'
          description: Next Status Id
          format: int32
      additionalProperties: false
      description: Admissions Checklist
    AdmissionsCheckListCollection:
      type: object
      properties:
        count:
          type: integer
          description: The number of items in the collection
          format: int32
          readOnly: true
        next_link:
          type:
          - string
          - 'null'
          description: For paginated responses, the URI for the next page of results
        value:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AdmissionsCheckList'
          description: The set of items included in the response. This may be a subset of the items in the collection
      additionalProperties: false
      description: A Collection
    CandidateInterviewReadModel:
      type: object
      properties:
        id:
          type:
          - integer
          - 'null'
          description: The ID of the candidate interview
          format: int32
        type:
          $ref: '#/components/schemas/SourceModel'
        start_time:
          type:
          - string
          - 'null'
          description: The start time of the interview
          format: date-time
        end_time:
          type:
          - string
          - 'null'
          description: The end time of the interview
          format: date-time
        interviewer:
          $ref: '#/components/schemas/UserBaseReadModel'
        interviewer_other:
          type:
          - string
          - 'null'
          description: Information for non-user interviewer
        accompanying_adults:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/UserBaseReadModel'
          description: An array of accompanying adult objects
        rating:
          type:
          - integer
          - 'null'
          description: The rating of the interview
          format: int32
        is_rescheduled:
          type:
          - boolean
          - 'null'
          description: True if interview was rescheduled
        did_not_show:
          type:
          - boolean
          - 'null'
          description: True if candidate did not show for interview
        comment:
          type:
          - string
          - 'null'
          description: The comment for the interview
      additionalProperties: false
      description: An object with candidate interview information
    AdmissionsCheckList:
      type: object
      properties:
        checklist_id:
          type: integer
          description: Identifier for a given checklist
          format: int32
        name:
          type:
          - string
          - 'null'
          description: Name of the checklist
        is_inactive:
          type: boolean
          description: Indicates if the checklist is active
        is_locked:
          type: boolean
          description: Indicates if the checklist is locked
        is_sample:
          type: boolean
          description: Indicates if the checklist is a sample
      additionalProperties: false
      description: Admissions Checklist
    V1AdmissionsCandidatesPost200ApplicationJsonResponse:
      type: integer
      format: int32
      x-apim-inline: true
    ApplicationModel:
      type: object
      properties:
        id:
          type:
          - integer
          - 'null'
          description: ''
          format: int32
        date_submitted:
          type:
          - string
          - 'null'
          description: ''
          format: date-time
        date_processed:
          type:
          - string
          - 'null'
          description: ''
          format: date-time
        source:
          $ref: '#/components/schemas/SourceModel'
      additionalProperties: false
      description: ''
    CandidateVisitReadModel:
      type: object
      properties:
        id:
          type:
          - integer
          - 'null'
          description: The ID of the candidate visit
          format: int32
        type:
          $ref: '#/components/schemas/SourceModel'
        start_time:
          type:
          - string
          - 'null'
          description: The start time of the visit
          format: date-time
        end_time:
          type:
          - string
          - 'null'
          description: The start time of the visit
          format: date-time
        guide:
          $ref: '#/components/schemas/UserBaseReadModel'
        guide_other:
          type:
          - string
          - 'null'
          description: Information for non-user guide
        accompanying_adults:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/UserBaseReadModel'
          description: An array of accompanying adult objects
        is_rescheduled:
          type:
          - boolean
          - 'null'
          description: True if visit was rescheduled
        did_not_show:
          type:
          - boolean
          - 'null'
          description: True if candidate did not show for visit
        comment:
          type:
          - string
          - 'null'
          description: The comment for the visit
      additionalProperties: false
      description: An object with candidate visit information
    SourceModel:
      type: object
      properties:
        id:
          type:
          - integer
          - 'null'
          description: ID of the field
          format: int32
        description:
          type:
          - string
          - 'null'
          description: Description of the field
      additionalProperties: false
      description: ''
    CandidateCreate:
      required:
      - checklist_id
      - entering_grade_id
      - entering_year
      - user_id
      type: object
      properties:
        user_id:
          type: integer
          description: ID for the user to be added as a candidate.
          format: int32
        entering_year:
          minLength: 1
          type: string
          description: The year for which the user is a candidate
        entering_grade_id:
          type: integer
          description: The ID for the grade in which the candidate is entering
          format: int32
        checklist_id:
          type: integer
          description: ID of the checklist to be updated as part of candidates creation
          format: int32
      additionalProperties: false
      description: Candidate Create
    CandidateEventReadModel:
      type: object
      properties:
        id:
          type:
          - integer
          - 'null'
          description: The ID of the candidate event
          format: int32
        name:
          type:
          - string
          - 'null'
          description: The name of the event
        type:
          $ref: '#/components/schemas/SourceModel'
        start_time:
          type:
          - string
          - 'null'
          description: The start time of the event
          format: date-time
        is_registered:
          type:
          - boolean
          - 'null'
          description: True if the candidate is registered
        attended:
          type:
          - boolean
          - 'null'
          description: True if the candidate attended the event
        comment:
          type:
          - string
          - 'null'
          description: The comment on the candidate event
      additionalProperties: false
      description: An object with candidate event information
    UserBaseReadModel:
      type: object
      properties:
        Id:
          type:
          - integer
          - 'null'
          description: The user ID of the user
          format: int32
        FirstName:
          type:
          - string
          - 'null'
          description: The first name of the user
        LastName:
          type:
          - string
          - 'null'
          description: The last name of the user
        Email:
          type:
          - string
          - 'null'
          description: The email of the user
      additionalProperties: false
      description: User base read model
    CandidateDecisionModel:
      type: object
      properties:
        id:
          type:
          - integer
          - 'null'
          description: ''
          format: int32
        name:
          type:
          - string
          - 'null'
          description: ''
        decision_type:
          type:
          - string
          - 'null'
          description: ''
        decision_type_id:
          type:
          - integer
          - 'null'
          description: ''
          format: int32
        date:
          type:
          - string
          - 'null'
          description: ''
          format: date-time
      additionalProperties: false
      description: ''
    CandidateRead:
      type: object
      properties:
        user_id:
          type:
          - integer
          - 'null'
          description: Unique Identifer for this candidate
          format: int32
        first_name:
          type:
          - string
          - 'null'
          description: Candidates first name
        last_name:
          type:
          - string
          - 'null'
          description: Candidates last name
        middle_name:
          type:
          - string
          - 'null'
          description: Candidates middle name
        prefix:
          type:
          - string
          - 'null'
          description: Prefix
        suffix:
          type:
          - string
          - 'null'
          description: Suffix
        nickname:
          type:
          - string
          - 'null'
          description: Candidates nick name (if available)
        role:
          type:
          - string
          - 'null'
          description: Role for this candidate.
        role_id:
          type:
          - integer
          - 'null'
          description: Identifier for thier role
          format: int32
        current_status:
          type:
          - string
          - 'null'
          description: Text representation of their current enrollment status
        status_id:
          type:
          - integer
          - 'null'
          description: Identifier for their enrollment status
          format: int32
        entering_year:
          type:
          - string
          - 'null'
          description: Text representation of the school year the candidate will be joining
        entering_year_id:
          type:
          - integer
          - 'null'
          description: Identifier for the school year the candidate will be joining
          format: int32
        entering_grade:
          type:
          - string
          - 'null'
          description: Text representation of the grade candidate will be joining
        entering_grade_id:
          type:
          - integer
          - 'null'
          description: Identifier for the grade candidate will be joining
          format: int32
        email:
          type:
          - string
          - 'null'
          description: Candidates email
        comment:
          type:
          - string
          - 'null'
          description: Comments
        parent1_email:
          type:
          - string
          - 'null'
          description: 1st Email of candidates parent
        parent2_email:
          type:
          - string
          - 'null'
          description: 2nd email of candidates parent
        international:
          type:
          - boolean
          - 'null'
          description: ''
        school_program:
          type:
          - string
          - 'null'
          description: ''
        gender:
          type:
          - string
          - 'null'
          description: ''
        ethnicity:
          type:
          - string
          - 'null'
          description: ''
        boarding_or_day:
          type:
          - string
          - 'null'
          description: ''
        financial_aid:
          type:
          - boolean
          - 'null'
          description: ''
        admissions_staff_id:
          type:
          - integer
          - 'null'
          description: ''
          format: int32
        admissions_staff:
          type:
          - string
          - 'null'
          description: ''
        inquiry_source:
          type:
          - string
          - 'null'
          description: ''
        inquiry_source_id:
          type:
          - integer
          - 'null'
          description: ''
          format: int32
        referral_type:
          type:
          - string
          - 'null'
          description: ''
        referral_type_id:
          type:
          - integer
          - 'null'
          description: ''
          format: int32
        has_iep:
          type:
          - boolean
          - 'null'
          description: ''
        has_504:
          type:
          - boolean
          - 'null'
          description: ''
        created_by:
          type:
          - string
          - 'null'
          description: ''
        created:
          type:
          - string
          - 'null'
          description: ''
          format: date-time
        modified_by:
          type:
          - string
          - 'null'
          description: ''
        modified:
          type:
          - string
          - 'null'
          description: ''
          format: date-time
        preferred_name:
          type:
          - string
          - 'null'
          description: ''
        decision:
          $ref: '#/components/schemas/SchoolDecisionModel'
        family_id:
          type:
          - integer
          - 'null'
          description: ''
          format: int32
        current_status_date:
          type:
          - string
          - 'null'
          description: Current status date
          format: date-time
        application:
          $ref: '#/components/schemas/ApplicationModel'
        events:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CandidateEventReadModel'
          description: An array of candidate event objects
        interviews:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CandidateInterviewReadModel'
          description: An array of candidate interview objects
        visits:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CandidateVisitReadModel'
          description: An array of candidate visit objects
      additionalProperties: false
      description: Candidate Read
  securitySchemes:
    Bb-Api-Subscription-Key:
      type: apiKey
      name: Bb-Api-Subscription-Key
      in: header
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.blackbaud.com/oauth/authorize
          tokenUrl: https://oauth2.sky.blackbaud.com/token
          scopes: {}